Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 1004 Bytes

README.dev.md

File metadata and controls

24 lines (21 loc) · 1004 Bytes

Steps for releasing:

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

Set up pre-commit hooks

npm run setup to install husky pre-commit hooks