Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 2.29 KB

RELEASE.md

File metadata and controls

62 lines (45 loc) · 2.29 KB
Raw

Release

Releases are mostly automated using release-it and lerna-changelog.

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 principles 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.

Release

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

  • Firste ensure that you have installed the projects dependencies:
pnpm install

export GITHUB_AUTH="f941e0..."
  • And last (but not least 😁) do your release:
pnpm release

release-it manages the actual release process. It will prompt you through the process of choosing the version number, tagging, pushing the tag and commits, etc.

The GitHub access token is required by release-it as well as lerna-changelog. It's needed by release-it in order to create a GitHub release and by lerna-changelog to avoid rate limiting issues. Both are configured to use the same environment variable (GITHUB_AUTH), which is not the default one for release-it.