Skip to content

Latest commit

 

History

History
161 lines (106 loc) · 8.34 KB

README.md

File metadata and controls

161 lines (106 loc) · 8.34 KB
Raw

React Release Scripts

The release process consists of several phases, each one represented by one of the scripts below.

A typical release goes like this:

  1. When a commit is pushed to the React repo, Circle CI will build all release bundles and run unit tests against both the source code and the built bundles.
  2. Next the release is published as a canary using the prepare-canary and publish scripts. (Currently this process is manual but might be automated in the future using GitHub "actions".)
  3. Finally, a canary releases can be promoted to stable1 using the prepare-stable and publish scripts. (This process is always manual.)

The high level process of creating releases is documented below. Individual scripts are documented as well:

Note that creating a patch release has a slightly different process than a major/minor release.

Process

If this is your first time running the release scripts, go to the scripts/release directory and run yarn to install the dependencies.

Publishing a Canary

Canaries are meant to be lightweight and published often. In most cases, canaries can be published using artifacts built by Circle CI.

To prepare a canary for a particular commit:

  1. Choose a commit from the commit log.
  2. Click the "“✓" icon and click the Circle CI "Details" link.
  3. Select the build job (not the build_experimental job; see the next section). If it's still pending, you'll need to wait for it to finish. (Note: This is the most awkward part of cutting a release right now. We have plans to improve it.)
  4. Copy the build ID from the URL (e.g. the build ID for circleci.com/gh/facebook/react/13471 is 13471).
  5. Run the prepare-canary script with the build ID you found 1:
scripts/release/prepare-canary.js --build=13471

Once the canary has been checked out and tested locally, you're ready to publish it:

scripts/release/publish.js --tags next

If the OTP code expires while publishing, re-run this command and answer "y" to the questions about whether it was expected for already published packages.

1: You can omit the build param if you just want to release the latest commit as a canary.

Publishing an Experimental Canary

Experimental canaries are special releases with additional features turned on.

The steps for publishing an experimental canary are almost the same as for publishing a normal canary, except in step 3 you should choose the build_experimental job instead of build. (I know this is awkward; we have plans to make it less so. Ideally these canaries would get published by a cron job.)

When publishing an experimental canary, use the experimental tag:

scripts/release/publish.js --tags experimental

If the OTP code expires while publishing, re-run this command and answer "y" to the questions about whether it was expected for already published packages.

Publishing a Stable Release

Stable releases should always be created from a previously-released canary. This encourages better testing of the actual release artifacts and reduces the chance of unintended changes accidentally being included in a stable release.

To prepare a stable release, choose a canary version and run the prepare-stable script 1:

scripts/release/prepare-stable.js --version=0.0.0-5bf84d292

This script will prompt you to select stable version numbers for each of the packages. It will update the package JSON versions (and dependencies) based on the numbers you select.

Once this step is complete, you're ready to publish the release:

scripts/release/publish.js --tags next latest

If the OTP code expires while publishing, re-run this command and answer "y" to the questions about whether it was expected for already published packages.

After successfully publishing the release, follow the on-screen instructions to ensure that all of the appropriate post-release steps are executed.

1: You can omit the version param if you just want to promote the latest canary to stable.

Creating a Patch Release

Patch releases should always be created by branching from a previous release. This reduces the likelihood of unstable changes being accidentally included in the release.

Begin by creating a branch from the previous git tag1:

git checkout -b 16.8.3 v16.8.2

Next cherry pick any changes from master that you want to include in the release:

git cherry-pick <commit-hash>

Once you have cherry picked all of the commits you want to include in the release, push your feature branch and create a Pull Request (so that Circle CI will create a canary):

git push origin 16.8.3

Once CI is complete, follow the regular canary and promote to stable processes.

1: The build-info.json artifact can also be used to identify the appropriate commit (e.g. unpkg.com/react@16.8.3/build-info.json shows us that react version 16.8.3 was created from commit 29b7b775f).

Scripts

create-canary

Creates a canary build from the current (local) Git revision.

This script is an escape hatch. It allows a canary release to be created without pushing a commit to be verified by Circle CI. It does not run any automated unit tests. Testing is solely the responsibility of the release engineer.

Note that this script git-archives the React repo (at the current revision) to a temporary directory before building, so uncommitted changes are not included in the build.

Example usage

To create a canary from the current branch and revision:

scripts/release/create-canary.js

prepare-canary

Downloads build artifacts from Circle CI in preparation to be published to NPM as a canary release.

All artifacts built by Circle CI have already been unit-tested (both source and bundles) but canaries should always be manually tested before being published. Upon completion, this script prints manual testing instructions.

Example usage

To prepare the artifacts created by Circle CI build 12677 you would run:

scripts/release/prepare-canary.js --build=12677

prepare-stable

Checks out a canary release from NPM and prepares it to be published as a stable release.

This script prompts for new (stable) release versions for each public package and updates the package contents (both package.json and inline version numbers) to match. It also updates inter-package dependencies to account for the new versions.

Canary release have already been tested but it is still a good idea to manually test and verify a release before publishing to ensure that e.g. version numbers are correct. Upon completion, this script prints manual testing instructions.

Example usage

To promote the canary release 0.0.0-5bf84d292 (aka commit 5bf84d292) to stable:

scripts/release/prepare-stable.js --version=0.0.0-5bf84d292

publish

Publishes the current contents of build/node_modules to NPM.

This script publishes each public package to NPM and updates the specified tag(s) to match. It does not test or verify the local package contents before publishing. This should be done by the release engineer prior to running the script.

Upon completion, this script provides instructions for tagging the Git commit that the package was created from and updating the release CHANGELOG.

Specify a --dry flag when running this script if you want to skip the NPM-publish step. In this event, the script will print the NPM commands but it will not actually run them.

Example usage

To publish a release to NPM as both next and latest:

scripts/release/publish.js --tags next latest