Steps for releasing:
- Review open issues and PRs to see if any can easily be fixed, closed, or merged.
- Bump copyright year in
README.md
, if necessary. - Consider whether any dependencies need to be updated.
- Review
CHANGELOG.md
for completeness and correctness. Update its release date. - Set the version in
package.json
. - Run
npm publish
. You can do this from the release branch. This will generate the docs, deploy docs, and publish the module to NPM. - Create a release PR containing the updates relating to any of the steps above.
- Create and push a git tag (e.g.
git tag -a v4.2.0 -m v4.2.0 && git push --tags
). - Manually create a release on GitHub to include the release-specific
notes found in
CHANGELOG.md
. - Verify the release on GitHub and NPM.
npm run setup
to install husky pre-commit hooks