release-process.md

Performing A Release

Releases are performed automatically with GitHub actions.

Note that protected tags are configured so you need to be either an admin or maintainer to push the tag.

1. git tag v<major>.<minor>.<patch> or git tag v<major>.<minor>.<patch>-<prerelease> ('v' required) where anything before the first . in <prerelease> will be become the npm dist-tag.
2. git push
3. git push --tag
4. Wait for the GitHub action to create a new draft GitHub release with the build attached. The publish to npm should happen around the same time from a different step.
5. Update the release notes to the new draft GitHub release if needed.
6. Publish the GitHub release.

Examples

• git tag -a v1.2.3 will result in 1.2.3 being published with the latest npm tag.
• git tag -a v1.2.3-beta will result in 1.2.3-beta being published with the beta npm tag.
• git tag -a v1.2.3-beta.1 will result in 1.2.3-beta.1 being published with the beta npm tag.