Add experimental instructions to release README (#17143)
Andrew Clark committed
Oct 18, 2019 at 16:26 UTC
3059ab3523d2462635afe4e53629b640b8ef9560
1 file changed
+15
scripts/release/README.md
+15
@@ -17,6 +17,8 @@ The high level process of creating releases is [documented below](#process). Ind
17
18
# Process
19
20
+If this is your first time running the release scripts, go to the `scripts/release` directory and run `yarn` to install the dependencies.
21
+
22
## Publishing a Canary
23
24
Canaries are meant to be lightweight and published often. In most cases, canaries can be published using artifacts built by Circle CI.
@@ -24,6 +26,7 @@ Canaries are meant to be lightweight and published often. In most cases, canarie
26
To prepare a canary for a particular commit:
27
1. Choose a commit from [the commit log](https://github.com/facebook/react/commits/master).
28
2. Click the "“✓" icon and click the Circle CI "Details" link.
29
+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.)
30
4. Copy the build ID from the URL (e.g. the build ID for [circleci.com/gh/facebook/react/13471](https://circleci.com/gh/facebook/react/13471) is **13471**).
31
5. Run the [`prepare-canary`](#prepare-canary) script with the build ID you found <sup>1</sup>:
32
```sh
@@ -37,6 +40,18 @@ scripts/release/publish.js --tags canary
40
41
<sup>1: You can omit the `build` param if you just want to release the latest commit as a canary.</sup>
42
43
+## Publishing an Experimental Canary
44
+
45
+Experimental canaries are special releases with additional features turned on.
46
+
47
+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.)
48
+
49
+When publishing an experimental canary, use the `experimental` tag:
50
+
51
+```sh
52
+scripts/release/publish.js --tags experimental
53
+```
54
+
55
## Publishing a Stable Release
56
57
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.