Skip to content
This repository has been archived by the owner on Jan 27, 2021. It is now read-only.

Latest commit

 

History

History
27 lines (22 loc) · 1.13 KB

RELEASE.md

File metadata and controls

27 lines (22 loc) · 1.13 KB

How to Release

This project is hosted on NPM. You can see it here. This project uses semantic-versioning to manage versions.

Below is a guide for releasing:

  • Checkout the main branch and run git pull to ensure you have the latest changes in main.
  • Be sure to check the changelog and ensure it has been updated accordingly.
  • Verify that the version number in the package.json is correct.
    • Confirm that the version matches the latest released version. The publish script will update the version.
  • Login to npm on the command line.
  • Run one of the following npm release scripts.
"release:major"
"release:minor"
"release:patch"

When run, these commands do the following:

  • Runs tests.
  • Bumps the version number in the package.json file according to the release command that has been run via npm version command.
  • Publishes the release to npm via npm publish command.
  • Creates a new git commit/tag in the process of publishing to npm.