Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.09 KB

README.dev.md

File metadata and controls

25 lines (22 loc) · 1.09 KB

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 Precious to tidy and lint

  1. Run mkdir -p local && ./bin/install-precious local to set up Precious locally
  2. Run ./git/setup.sh to set up pre-commit hook that invokes Precious