Publish a local release (canary or stable) to NPM (facebook#14260)

New release scripts. Learn more at https://github.com/facebook/react/blob/master/scripts/release/README.md
junihoj · Nov 23, 2018 · 686f106 · 686f106
1 parent 7475120
commit 686f106
Show file tree

Hide file tree

Showing 93 changed files with 1,731 additions and 1,274 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -42,4 +42,7 @@ jobs:
             - node_modules
 
       - store_artifacts:
-          path: ./node_modules.tgz
+          path: ./node_modules.tgz
+
+      - store_artifacts:
+          path: ./scripts/error-codes/codes.json
diff --git a/fixtures/attribute-behavior/package.json b/fixtures/attribute-behavior/package.json
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "prestart":
-      "cp ../../build/dist/react.development.js public/ && cp ../../build/dist/react-dom.development.js public/ && cp ../../build/dist/react-dom-server.browser.development.js public/",
+      "cp ../../build/node_modules/react/umd/react.development.js public/ && cp ../../build/node_modules/react-dom/umd/react-dom.development.js public/ && cp ../../build/node_modules/react-dom/umd/react-dom-server.browser.development.js public/",
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test --env=jsdom",

diff --git a/fixtures/dom/package.json b/fixtures/dom/package.json
@@ -18,7 +18,7 @@
   },
   "scripts": {
     "start": "react-scripts start",
-    "prestart": "cp ../../build/dist/react.development.js ../../build/dist/react-dom.development.js ../../build/dist/react.production.min.js ../../build/dist/react-dom.production.min.js ../../build/dist/react-dom-server.browser.development.js ../../build/dist/react-dom-server.browser.production.min.js public/",
+    "prestart": "cp ../../build/node_modules/react/umd/react.development.js ../../build/node_modules/react-dom/umd/react-dom.development.js ../../build/node_modules/react/umd/react.production.min.js ../../build/node_modules/react-dom/umd/react-dom.production.min.js ../../build/node_modules/react-dom/umd/react-dom-server.browser.development.js ../../build/node_modules/react-dom/umd/react-dom-server.browser.production.min.js public/",
     "build": "react-scripts build && cp build/index.html build/200.html",
     "test": "react-scripts test --env=jsdom",
     "eject": "react-scripts eject"

diff --git a/fixtures/expiration/package.json b/fixtures/expiration/package.json
@@ -9,7 +9,7 @@
   },
   "scripts": {
     "prestart":
-      "cp ../../build/dist/react.development.js public/ && cp ../../build/dist/react-dom.development.js public/",
+      "cp ../../build/node_modules/react/umd/react.development.js public/ && cp ../../build/node_modules/react-dom/umd/react-dom.development.js public/",
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test --env=jsdom",

diff --git a/fixtures/fiber-triangle/index.html b/fixtures/fiber-triangle/index.html
@@ -16,8 +16,8 @@ <h1>Fiber Example</h1>
         If you checked out the source from GitHub make sure to run <code>npm run build</code>.
       </p>
     </div>
-    <script src="../../build/dist/react.development.js"></script>
-    <script src="../../build/dist/react-dom.development.js"></script>
+    <script src="../../build/node_modules/react/umd/react.development.js"></script>
+    <script src="../../build/node_modules/react-dom/umd/react-dom.development.js"></script>
     <script src="https://unpkg.com/babel-standalone@6/babel.js"></script>
     <script type="text/babel">
       var dotStyle = {

diff --git a/fixtures/packaging/babel-standalone/dev.html b/fixtures/packaging/babel-standalone/dev.html
@@ -1,7 +1,7 @@
 <html>
   <body>
-    <script src="../../../build/dist/react.development.js"></script>
-    <script src="../../../build/dist/react-dom.development.js"></script>
+    <script src="../../../build/node_modules/react/umd/react.development.js"></script>
+    <script src="../../../build/node_modules/react-dom/umd/react-dom.development.js"></script>
     <script src="https://unpkg.com/babel-standalone@6/babel.js"></script>
     <div id="container"></div>
     <script type="text/babel">

diff --git a/fixtures/packaging/globals/dev.html b/fixtures/packaging/globals/dev.html
@@ -1,7 +1,7 @@
 <html>
   <body>
-    <script src="../../../build/dist/react.development.js"></script>
-    <script src="../../../build/dist/react-dom.development.js"></script>
+    <script src="../../../build/node_modules/react/umd/react.development.js"></script>
+    <script src="../../../build/node_modules/react-dom/umd/react-dom.development.js"></script>
     <div id="container"></div>
     <script>
       ReactDOM.render(

diff --git a/fixtures/packaging/globals/prod.html b/fixtures/packaging/globals/prod.html
@@ -1,7 +1,7 @@
 <html>
   <body>
-    <script src="../../../build/dist/react.production.min.js"></script>
-    <script src="../../../build/dist/react-dom.production.min.js"></script>
+    <script src="../../../build/node_modules/react/umd/react.production.min.js"></script>
+    <script src="../../../build/node_modules/react-dom/umd/react-dom.production.min.js"></script>
     <div id="container"></div>
     <script>
       ReactDOM.render(

diff --git a/fixtures/packaging/requirejs/dev.html b/fixtures/packaging/requirejs/dev.html
@@ -5,8 +5,8 @@
     <script>
       requirejs.config({
         paths: {
-          react: '../../../build/dist/react.development',
-          'react-dom': '../../../build/dist/react-dom.development'
+          react: '../../../build/node_modules/react/umd/react.development',
+          'react-dom': '../../../build/node_modules/react-dom/umd/react-dom.development'
         }
       });
 

diff --git a/fixtures/packaging/requirejs/prod.html b/fixtures/packaging/requirejs/prod.html
@@ -5,8 +5,8 @@
     <script>
       requirejs.config({
         paths: {
-          react: '../../../build/dist/react.production.min',
-          'react-dom': '../../../build/dist/react-dom.production.min'
+          react: '../../../build/node_modules/react/umd/react.production.min',
+          'react-dom': '../../../build/node_modules/react-dom/umd/react-dom.production.min'
         }
       });
 

diff --git a/fixtures/packaging/rjs/dev/config.js b/fixtures/packaging/rjs/dev/config.js
@@ -4,8 +4,9 @@ module.exports = {
   out: 'output.js',
   optimize: 'none',
   paths: {
-    react: '../../../../build/dist/react.development',
-    'react-dom': '../../../../build/dist/react-dom.development',
+    react: '../../../../build/node_modules/react/umd/react.development',
+    'react-dom':
+      '../../../../build/node_modules/react-dom/umd/react-dom.development',
     schedule: '../../../../build/dist/schedule.development',
   },
 };
diff --git a/fixtures/packaging/rjs/prod/config.js b/fixtures/packaging/rjs/prod/config.js
@@ -4,8 +4,9 @@ module.exports = {
   out: 'output.js',
   optimize: 'none',
   paths: {
-    react: '../../../../build/dist/react.production.min',
-    'react-dom': '../../../../build/dist/react-dom.production.min',
+    react: '../../../../build/node_modules/react/umd/react.production.min',
+    'react-dom':
+      '../../../../build/node_modules/react-dom/umd/react-dom.production.min',
     schedule: '../../../../build/dist/schedule.development',
   },
 };
diff --git a/fixtures/packaging/systemjs-builder/dev/config.js b/fixtures/packaging/systemjs-builder/dev/config.js
@@ -1,7 +1,8 @@
 System.config({
   paths: {
-    react: '../../../../build/dist/react.development.js',
-    'react-dom': '../../../../build/dist/react-dom.development.js',
+    react: '../../../../build/node_modules/react/umd/react.development.js',
+    'react-dom':
+      '../../../../build/node_modules/react-dom/umd/react-dom.development.js',
     schedule: '../../../../build/dist/schedule.development',
   },
 });
diff --git a/fixtures/packaging/systemjs-builder/prod/config.js b/fixtures/packaging/systemjs-builder/prod/config.js
@@ -1,7 +1,8 @@
 System.config({
   paths: {
-    react: '../../../../build/dist/react.production.min.js',
-    'react-dom': '../../../../build/dist/react-dom.production.min.js',
+    react: '../../../../build/node_modules/react/umd/react.production.min.js',
+    'react-dom':
+      '../../../../build/node_modules/react-dom/umd/react-dom.production.min.js',
     schedule: '../../../../build/dist/schedule.development',
   },
 });
diff --git a/fixtures/packaging/systemjs/dev.html b/fixtures/packaging/systemjs/dev.html
@@ -5,8 +5,8 @@
     <script>
       System.config({
         paths: {
-          react: '../../../build/dist/react.development.js',
-          'react-dom': '../../../build/dist/react-dom.development.js'
+          react: '../../../build/node_modules/react/umd/react.development.js',
+          'react-dom': '../../../build/node_modules/react-dom/umd/react-dom.development.js'
         }
       });
 

diff --git a/fixtures/packaging/systemjs/prod.html b/fixtures/packaging/systemjs/prod.html
@@ -5,8 +5,8 @@
     <script>
       System.config({
         paths: {
-          react: '../../../build/dist/react.production.min.js',
-          'react-dom': '../../../build/dist/react-dom.production.min.js'
+          react: '../../../build/node_modules/react/umd/react.production.min.js',
+          'react-dom': '../../../build/node_modules/react-dom/umd/react-dom.production.min.js'
         }
       });
 

diff --git a/fixtures/scheduler/index.html b/fixtures/scheduler/index.html
@@ -91,7 +91,7 @@ <h2>Tests:</h2>
       <div> If the counter advanced while you were away from this tab, it's correct.</div>
     </li>
   </ol>
-  <script src="../../build/dist/react.development.js"></script>
+  <script src="../../build/node_modules/react/umd/react.development.js"></script>
   <script src="../../build/node_modules/scheduler/umd/scheduler.development.js"></script>
   <script src="https://unpkg.com/babel-standalone@6/babel.js"></script>
   <script type="text/babel">

diff --git a/package.json b/package.json
@@ -93,7 +93,7 @@
     "testRegex": "/scripts/jest/dont-run-jest-directly\\.js$"
   },
   "scripts": {
-    "build": "npm run version-check && node ./scripts/rollup/build.js",
+    "build": "node ./scripts/rollup/build.js",
     "linc": "node ./scripts/tasks/linc.js",
     "lint": "node ./scripts/tasks/eslint.js",
     "lint-build": "node ./scripts/rollup/validate/index.js",

diff --git a/packages/create-subscription/package.json b/packages/create-subscription/package.json
@@ -6,6 +6,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/"
   ],

diff --git a/packages/eslint-plugin-react-hooks/package.json b/packages/eslint-plugin-react-hooks/package.json
@@ -7,6 +7,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs"
   ],

diff --git a/packages/jest-react/package.json b/packages/jest-react/package.json
@@ -22,6 +22,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/"
   ]

diff --git a/packages/react-art/package.json b/packages/react-art/package.json
@@ -31,6 +31,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/",
     "umd/",

diff --git a/packages/react-cache/package.json b/packages/react-cache/package.json
@@ -7,6 +7,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/",
     "umd/"

diff --git a/packages/react-debug-tools/package.json b/packages/react-debug-tools/package.json
@@ -12,6 +12,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/"
   ],

diff --git a/packages/react-dom/package.json b/packages/react-dom/package.json
@@ -24,6 +24,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "profiling.js",
     "server.js",

diff --git a/packages/react-is/package.json b/packages/react-is/package.json
@@ -15,6 +15,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/",
     "umd/"

diff --git a/packages/react-noop-renderer/package.json b/packages/react-noop-renderer/package.json
@@ -18,6 +18,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "persistent.js",
     "cjs/"

diff --git a/packages/react-reconciler/package.json b/packages/react-reconciler/package.json
@@ -11,6 +11,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "persistent.js",
     "reflection.js",

diff --git a/packages/react-test-renderer/package.json b/packages/react-test-renderer/package.json
@@ -26,6 +26,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "shallow.js",
     "cjs/",

diff --git a/packages/react/package.json b/packages/react/package.json
@@ -11,6 +11,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "cjs/",
     "umd/"

diff --git a/packages/scheduler/package.json b/packages/scheduler/package.json
@@ -19,6 +19,7 @@
   "files": [
     "LICENSE",
     "README.md",
+    "build-info.json",
     "index.js",
     "tracing.js",
     "tracing-profiling.js",

diff --git a/scripts/circleci/add_build_info_json.sh b/scripts/circleci/add_build_info_json.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+
+node ./scripts/release/ci-add-build-info-json.js
diff --git a/scripts/circleci/test_entry_point.sh b/scripts/circleci/test_entry_point.sh
@@ -25,6 +25,8 @@ if [ $((1 % CIRCLE_NODE_TOTAL)) -eq "$CIRCLE_NODE_INDEX" ]; then
 fi
 
 if [ $((2 % CIRCLE_NODE_TOTAL)) -eq "$CIRCLE_NODE_INDEX" ]; then
+  COMMANDS_TO_RUN+=('./scripts/circleci/add_build_info_json.sh')
+  COMMANDS_TO_RUN+=('./scripts/circleci/update_package_versions.sh')
   COMMANDS_TO_RUN+=('./scripts/circleci/build.sh')
   COMMANDS_TO_RUN+=('yarn test-build --maxWorkers=2')
   COMMANDS_TO_RUN+=('yarn test-build-prod --maxWorkers=2')

diff --git a/scripts/circleci/update_package_versions.sh b/scripts/circleci/update_package_versions.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+
+node ./scripts/release/ci-update-package-versions.js
diff --git a/scripts/release/README.md b/scripts/release/README.md
@@ -1,13 +1,66 @@
 # React Release Scripts
 
-At a high-level, the release process uses two scripts: **build** and **publish**.
-1. The **build** script does the heavy lifting (e.g., checking CI, running automated tests, building Rollup bundles) and then prints instructions for manual verification.
-1. The **publish** script then publishes the built artifacts to npm and pushes to GitHub.
+The release process consists of several phases, each one represented by one of the scripts below.
 
-Run either script without parameters to see its usage, e.g.:
+A typical release goes like this:
+1. When a commit is pushed to the React repo, [Circle CI](https://circleci.com/gh/facebook/react/) 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`](#prepare-canary) and [`publish`](#publish) scripts. (Currently this process is manual but might be automated in the future using [GitHub "actions"](https://github.com/features/actions).)
+3. Finally, a canary releases can be promoted to stable using the [`prepare-stable`](#prepare-stable) and [`publish`](#publish) scripts. (This process is always manual.)
+
+One or more release scripts are used for each of the above phases. Learn more about these scripts below:
+* [`create-canary`](#create-canary)
+* [`prepare-canary`](#prepare-canary)
+* [`prepare-stable`](#prepare-stable)
+* [`publish`](#publish)
+
+## `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:
+```sh
+scripts/release/create-canary.js
 ```
-./scripts/release/build.js
-./scripts/release/publish.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](https://circleci.com/gh/facebook/react/12677#artifacts/containers/0) you would run:
+```sh
+scripts/release/prepare-canary.js --build=12677
 ```
 
-Each script will guide the release engineer through any necessary steps (including environment setup and manual testing steps).
+## `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](https://github.com/facebook/react/commit/5bf84d292)) to stable:
+```sh
+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`:
+```sh
+scripts/release/publish.js --tags next latest
+```