Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 703 Bytes

DEPLOY.md

File metadata and controls

16 lines (12 loc) · 703 Bytes
Raw

Deploy

To deploy the package, do the following steps:

  1. Bump version in package.json
  2. Verify dependencies and peerDependencies version ranges
  3. Add a new header in CHANGELOG.md to separate the previously "Unreleased" changes from the "Unreleased" section (which should still stay there)
  4. Make any needed README.md or documentation changes.
  5. Make a PR + merge into main as usual

After a successful build on main, the package is automatically deploy to NPM. When this is done, do the following steps:

  1. Tag the commit on GitHub:
    • Tag version = vX.Y.Z
    • Release title same as tag version
    • Description should be everything in the CHANGELOG.md for this version