Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Making a release

The new version number must follow semantic versioning and look like X.Y.Z. To make a new release follow these steps:

  1. Create or update the release notes at book/src/releases/vX.Y.Z.md and make a PR to merge them into develop. The release notes should include a migration guide if there are breaking changes.
  2. Run npm run version X.Y.Z and make a PR to merge the resulting version bump commit into develop.
  3. Make a PR to merge develop into main.
  4. Run git push origin vX.Y.Z to publish the tag that was created by npm run version and start the CI release process.
  5. Verify that CI successfully builds and releases to npm and creates a release on GitHub.