Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 2.66 KB

RELEASE.md

File metadata and controls

78 lines (54 loc) · 2.66 KB

Release Process

Updating the Changelog and the Cargo.toml version are mostly automated using release-it and lerna-changelog.

The deployment to npm is automatic and will happen when you push a tag to GitHub.

Preparation

Since the majority of the actual release process is automated, the primary remaining task prior to releasing is confirming that all pull requests that have been merged since the last release have been labeled with the appropriate lerna-changelog labels and the titles have been updated to ensure they represent something that would make sense to our users. Some great information on why this is important can be found at keepachangelog.com, but the overall guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

  • breaking - Used when the PR is considered a breaking change.
  • enhancement - Used when the PR adds a new feature or enhancement.
  • bug - Used when the PR fixes a bug included in a previous release.
  • documentation - Used when the PR adds or updates documentation.
  • internal - Used for internal changes that still require a mention in the changelog/release notes.

Prepare the changelog

Once the prep work is completed, the actual release is straight forward:

  • Make sure that you are on a branch other than main. The changelog and version bump should be done as a PR, reviewed, and merged before the tag is created and the release is pushed to npm.

  • ensure that you have installed your projects dependencies:

npm install

  • ensure that you have obtained a GitHub personal access token with the repo scope (no other permissions are needed). Make sure the token is available as the GITHUB_AUTH environment variable.

    For instance:

    export GITHUB_AUTH=abc123def456
  • Update the changelog and bump the version:
npx release-it

release-it manages the actual release process. It will prompt you to to choose the version number after which you will have the chance to hand tweak the changelog to be used.

## Tag and Release

Once your PR that updates the Changelog and bumps the version is released you need to tag that commit and push that tag to github.

git checkout main
git pull
git tag v[version-number]

remember to replace [version-number] with the release you are doing.

then push that tag:

git push --tags