Skip to content

Commit 921997e

Browse files
committed
docs: add release instructions to README
1 parent 560b272 commit 921997e

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,22 @@ Node.js v22.3.0
343343
└─────────┴───────────────────────┴─────────┴────────────────────┴────────────┴─────────────────────────┘
344344
```
345345

346+
## Release
347+
348+
Use `npm version` to bump the version, create a git tag, and push to trigger the release workflow.
349+
350+
```bash
351+
# Stable release
352+
npm version patch # or minor, major
353+
git push origin master --tags
354+
355+
# Pre-release (beta, alpha, rc, etc.)
356+
npm version 5.0.0-beta.0
357+
git push origin master --tags
358+
```
359+
360+
The [release workflow](.github/workflows/release.yml) will automatically publish to npm and create a GitHub Release when a `v*` tag is pushed. Pre-release tags (e.g., `v5.0.0-beta.0`) are published with the corresponding dist-tag (`beta`, `alpha`, `rc`, etc.).
361+
346362
## License
347363

348364
[MIT](LICENSE)

0 commit comments

Comments
 (0)