Skip to content

Commit

Permalink
Fix documentation of the release process (#12337)
Browse files Browse the repository at this point in the history
* Adusted grammar in release script readme.

* Adjusts title and explanation about the release process.
  • Loading branch information
FlXlT authored and gaearon committed Apr 16, 2018
1 parent 2e1cc28 commit 1e97a71
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions scripts/release/README.md
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).

0 comments on commit 1e97a71

Please sign in to comment.