To create a stable release follow the following steps
- Checkout the head of master
git checkout master && git pull
- Create a new release branch from master e.g
release
- Install the dependencies
yarn install --frozen-lockfile
- Build the package
yarn build
- Test the package
yarn test
- Run
yarn version:release
, note by default this will do a minor package release as we are pre the1.0.0
release - Observe the correctly incremented change to the
package.json
and the new entry inCHANGELOG.md
along with the newly created commit - Push the release branch including the newly created tags
git push origin release --tags
- Open a pull request for the release, once approvals have been sought, merge the pull request using squash,
preserving the commit message as
chore(release): publish [skip ci]
- Observe the triggering of the
/.github/workflows/release.yaml
The resulting release will publish as a github release.