Skip to content

release.md

Latest commit

 

History

History
75 lines (47 loc) · 2.57 KB

release.md

File metadata and controls

75 lines (47 loc) · 2.57 KB

Releasing

Update the version numbers:

First, make sure you're up-to-date. You are on the master branch, with nothing new to pull. From the list of new commits since the last release, determine what kind of release you're making: is it a patch? A new minor?

For a patch, run:

yarn update-version patch

or for a new minor:

yarn update-version minor

If you need to jump to a higher version number (e.g. if you're skipping some BCL versions, upgrading from BCL 2.3.x to 2.6.y), you will have to provide the version number manually:

yarn update-version 2.6.0

If you don't provide any arguments and just run yarn update-version, lerna will try to infer the new version automatically from the git commits messages. This hasn't been tested yet in this repository, so please be careful when using it.

Create a change log entry for the release:

You'll need an access token for the GitHub API. Save it to this environment variable: export GITHUB_AUTH="..."

  • Run npm run changelog. The command will find all the labeled pull requests merged since the last release and create a change log entry with all the changes and links to PRs and their authors.
  • Copy and paste the output from the changelog generator to CHANGELOG.md.

Publish the packages:

Once the version changes have been committed, you are ready to publish the packages.

First, make sure you're correctly logged in. If the command npm whoami doesn't return your npm username, then log in: npm login.

Now, all you have to sit comfortably, run the following command, confirm the publishing and watch the magic happens:

npm run publish

Note: you might be bombarded with emails from npm (one for each published package), this is the price of success.

Create a new GitHub release:

Final step: create a new GitHub release from the master branch. The tag version should be prefixed with v, e.g. v2.3.0. As a title, you can use something like 2.3.0 (2019-06-14) (like in the root CHANGELOG.md but without the link). And for the description of the release, you can copy-paste the entry generated in the root CHANGELOG.md.

Troubleshooting:

In case of a failure during the release of the packages on npmjs.com which results in a subset of the packages being published, retry to publish the missing ones after clearing history:

npm run publish

then, after the failure:

git reset --hard

and then again.

npm run publish

until the whole set of packages gets published, hopefully.