-
Notifications
You must be signed in to change notification settings - Fork 46.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix documentation of the release process (#12337)
* Adusted grammar in release script readme. * Adjusts title and explanation about the release process.
- Loading branch information
Showing
1 changed file
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
# React Release Script | ||
# React Release Scripts | ||
|
||
At a high-level, the release script runs in 2 passes: **build** and **publish**. | ||
1. The **build** script does the heavy lifting (eg 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. | ||
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. | ||
|
||
Run either script without parameters to see its usage, eg: | ||
Run either script without parameters to see its usage, e.g.: | ||
``` | ||
./scripts/release/build.js | ||
./scripts/release/publish.js | ||
``` | ||
|
||
Each script will guide the release engineer through any necessary steps (including environment setup and manual testing steps). | ||
Each script will guide the release engineer through any necessary steps (including environment setup and manual testing steps). |