Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.13 KB

creating-a-release.md

File metadata and controls

76 lines (50 loc) · 3.13 KB
Raw

Creating a Pharos release

When the set of unreleased changes feels like a shippable set of value, the maintainers will typically plan, make, and announce a new release.

Preparing for a release

The develop branch's latest changes must be merged into the main branch. It's important to do a fast-forward merge to avoid additional merge commits:

$ git checkout develop
$ git pull origin develop
$ git checkout main
$ git merge develop --ff
$ git push origin main

This brings the set of changes onto the main branch for a stable release. If that's successful, you'll be ready to publish the release.

Publishing a release (automated)

After pushing the commits to main, the Changesets action will create a pull request, titled Version Packages, with all of the package versions and changelogs updated. This pull request will automatically update whenever new changesets are pushed to main. When you're ready, you can merge the pull request and the action will publish the new versions to NPM for you.

Finally, be sure to follow the post-release activities.

Publishing a release (manually)

If the Changesets action is not working as expected you can instead use the Changesets cli to version and publish the package manually. First you'll need to update the versions for all packages described in the changesets since last release:

$ yarn changeset version

This command reads, then deletes, the changesets for the release.

Changesets requires access to GitHub to properly link to commits, pull requests, and authors. If you see the following error, you'll first need to create a personal access token on GitHub. Be sure to save this token value somewhere safe before leaving the screen or you'll have to generate another one.

🦋  error Error: Please create a GitHub personal access token at https://github.com/settings/tokens/new and add it as the GITHUB_TOKEN environment variable

Be sure you commit the changes resulting from the versioning command to the main branch before you continue.

Once you've merged the versioning changes, it's time to publish the new versions:

$ yarn changeset publish

This publishes the newly-versioned packages to npm and creates Git tags which you need to push to GitHub:

$ git push --follow-tags

Finally, be sure to follow the post-release activities.

Post release activities

Following an automated or manual release, the latest changes of main must be merged into develop. It's important to do a fast-forward merge to avoid additional merge commits:

$ git checkout main
$ git pull origin main
$ git checkout develop
$ git merge main --ff
$ git push origin develop