-
Notifications
You must be signed in to change notification settings - Fork 6
Release
Dominik Burgdörfer edited this page Jul 1, 2026
·
1 revision
Create a dedicated branch (e.g. chore/update-dependencies).
Run:
npm updateVerify everything still works:
npm testCommit the updated package.json and package-lock.json, open a pull request, and merge it.
Create a dedicated branch (e.g. chore/release).
Make sure the development server is not running before proceeding — the npm version command starts it internally to run the test suite.
Choose the version increment according to Semantic Versioning:
| Increment | When to use |
|---|---|
patch |
Bug fixes that are backward-compatible |
minor |
New features that are backward-compatible |
major |
Breaking changes |
Run the appropriate command:
npm version patch # or minor, or majorThis automatically:
- updates
"version"inpackage.json - creates a git commit with the message
vX.Y.Z - creates a git tag
vX.Y.Z
Push the branch and the tag:
git push --follow-tagsOpen a pull request and merge it.
- Go to the repository on GitHub and navigate to Releases → Draft a new release.
- Select the version tag created in the previous step (e.g.
v2.0.30). - Click Generate release notes to auto-generate the changelog from merged pull requests.
- Delete the entry for the version bump PR (e.g. "chore/release") — it is an implementation detail and should not appear in the public changelog.
- Click Publish release.
Publishing the release automatically triggers the npm-publish workflow, which runs npm test and then publishes the package to the npm registry.