Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.33 KB

RELEASE.md

File metadata and controls

34 lines (23 loc) · 1.33 KB
Raw

Release Guidelines

How to do a release

This should only ever be done by a very short list of core contributors

Releasing is a two-step process. The first step uses a GitHub action updates the package versions and changelogs, and the second step publishes updated packages to NPM.

Update Packages (automatic)

This step is handled for us by the Release GitHub Action. As PRs are opened against main, this action will open and update a PR which generates the appropriate CHANGELOG.md entries and package.json version bumps. The generated PR has the title "Version Packages"

Once ready for a release, approve the "Version Packages" PR and merge it into main.

Publish Packages

Once the "Version Packages" PR is merged into main, to do a manual release:

git checkout main && \
git pull && \
yarn fresh && \
yarn publish-changed && \
git push --tags

The yarn publish-changed command finds packages where the version listed in the package.json is ahead of the version published on npm, and attempts to publish just those packages. As part of this step you will be asked for a one time password (OTP) for NPM. You can access this from your authentication app.

NOTE: There is no reason you should ever manually edit the version in the package.json