RELEASE.md

Release

Instruction on how to cut a new release.

Steps

Bump Version

1. Run the following script to update package.json. This will also create and push to a new branch.

   # releasing new minor version & git remote is origin
   ./scripts/release-version-bump minor origin

2. Update CHANGELOG.md as needed and push to branch.

3. Create PR

Create GitHub Release

1. Once PR is merge

2. Run the following script to tag master branch. This will kick off the release pipeline to auto build and create a GitHub release.

   # origin is my git remote, change it to whatever yours is
   ./scripts/tag-release.sh origin

3. The release will also include a changelog of commits made since last release. This can be turn off.