RELEASING.md

Overview

We practice trunk based development and main is the branch we release from.

Create a release branch, update the following files with proper version info:

• CHANGELOG.md
• package.json

Create pull request, review, publish package, git tag and push, prepare package.json with next dev version, merge, create GitHub release.

Step by step

1. pull latest main
2. review "Unreleased" in CHANGELOG.md to double-check if the release should be a major, minor, or patch release vX.Y.Z
3. create a new branch release/vX.Y.Z matching the version number you identified
4. update links and headings in CHANGELOG.md to reflect the new version
5. update package.json if needed to match the version, and remove any prelease suffix (ensure package-lock.json is up to date)
6. commit your changes
7. open a pull request with your new release branch
8. get the pull request reviewed and approved
9. run ./pre-publish.sh vX.Y.Z (it will run tests and ensure a clean build, and remind you of the steps below)
10. tag the approved commit vX.Y.Z
11. publish the NPM package
12. bump the version in package.json up to the next patch version, with a "-dev" suffix
13. push the branch, then squash merge your changes to main
14. DO NOT delete the release branch
15. create a matching GitHub release