# Stable Releases

To create a stable release follow the following steps

1. Checkout the head of master `git checkout master && git pull`
2. Create a new release branch from master e.g `release`
3. Ensure the package is clean from previous branches/builds `yarn clean`
4. Install the dependencies `yarn install --frozen-lockfile`
5. Build the package `yarn build`
6. Run `yarn version:release`, note by default this will do a minor package release as we are pre the `1.0.0` release
7. Observe the correctly incremented change to the `package.json` and the new entry in `CHANGELOG.md` along with the
   newly created commit
8. Push the release branch including the newly created tags `git push origin release --tags`
9. Open a pull request for the release, once approvals have been sought, merge the pull request using rebase, preserving
   the commit message as `chore(release): publish [skip ci]`
10. Observe the triggering of the `/.github/workflows/push-release.yaml`

**Note** It is important that rebase is used as the strategy for merging a release pull request as this preserves the
created release tag.

The resulting release will publish the new package to NPM and the resulting binaries to github packages.

# Unstable Releases

An unstable release is triggered on every commit to master, where the `/.github/workflows/push-master.yaml` is run.

The releases have the following version syntax
`<current package version + patch version>-unstable.<current git commit reference>`

**Note** The `/.github/workflows/push-master.yaml` will skip if the commit message includes `[skip ci]`

**Note** To skip the automatic release of a new unstable version append `[skip ci]` to the end of the commit message
that is merged into master.