@samitouri / QOS-React / commits / 1e97a71a82

Fix documentation of the release process (#12337)

* Adusted grammar in release script readme. * Adjusts title and explanation about the release process.

Floris Doolaard committed Apr 16, 2018 at 16:45 UTC 1e97a71a829e698ddac0a5e15fbdec97d35ed2bc
1 file changed +6 -6
scripts/release/README.md
+6 -6
@@ -1,13 +1,13 @@
1 -# React Release Script
1 +# React Release Scripts
2
3 -At a high-level, the release script runs in 2 passes: **build** and **publish**.
4 -1. The **build** script does the heavy lifting (eg checking CI, running automated tests, building Rollup bundles) and then prints instructions for manual verification.
5 -1. The **publish** script then publishes the built artifacts to NPM and pushes to GitHub.
3 +At a high-level, the release process uses two scripts: **build** and **publish**.
4 +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.
5 +1. The **publish** script then publishes the built artifacts to npm and pushes to GitHub.
6
7 -Run either script without parameters to see its usage, eg:
7 +Run either script without parameters to see its usage, e.g.:
8 ```
9 ./scripts/release/build.js
10 ./scripts/release/publish.js
11 ```
12
13 -Each script will guide the release engineer through any necessary steps (including environment setup and manual testing steps).
\ No newline at end of file
13 +Each script will guide the release engineer through any necessary steps (including environment setup and manual testing steps).