Skip to content

Release

Dominik Burgdörfer edited this page Jul 1, 2026 · 1 revision

Release Process

1. Update Dependencies

Create a dedicated branch (e.g. chore/update-dependencies).

Run:

npm update

Verify everything still works:

npm test

Commit the updated package.json and package-lock.json, open a pull request, and merge it.

2. Bump the Version

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 major

This automatically:

  • updates "version" in package.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-tags

Open a pull request and merge it.

3. Create a GitHub Release

  1. Go to the repository on GitHub and navigate to Releases → Draft a new release.
  2. Select the version tag created in the previous step (e.g. v2.0.30).
  3. Click Generate release notes to auto-generate the changelog from merged pull requests.
  4. 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.
  5. 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.

Clone this wiki locally