RELEASE.md

Release Instructions

Pre-Commit

1. fix-n-fmt
2. yarn test

Release

1. git checkout main; git pull origin main
2. git checkout -b <username>/<version>
3. Bump version number in version in Cargo.toml
4. npm version minor --no-commit-hooks --no-git-tag-version
   • Can be 'patch' or 'major' instead of 'minor'
5. Verify version numbers all match in git diff --cached
6. Update CHANGELOG.md
7. yarn build && yarn docs
8. git add .
9. git commit -m '<version>'
10. git push origin <username>/<version>
    • Or with graphite: gt track and gt submit
11. Create a pull request off this branch
    • Make sure the name of the pull request is also just the <version> so the workflow will know to do a release.
    • Do not prepend the <version> with v. For instance, if releasing 1.1.0, the PR should be named 1.1.0, NOT v1.1.0
12. Merge the pull request
13. Verify release appears on NPM