Skip to content

Commit

Permalink
Tweaked README
Browse files Browse the repository at this point in the history
  • Loading branch information
bvaughn committed Oct 16, 2017
1 parent 70eae06 commit bc093c9
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions scripts/release/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# React Release Script

At a high-level, the new release script runs in 2 passes: **build** and **publish**. The **build** script does the heavy lifting (eg checking CI, running automated tests, building Rollup bundles) and then prints instructions for manual verification. The **release** script then publishes the built artifacts to NPM and pushes to GitHub.
At a high-level, the new 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 **release** script then publishes the built artifacts to NPM and pushes to GitHub.

Run a script without any parameters to see its usage, eg:
```
node ./build.js
```
./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).

0 comments on commit bc093c9

Please sign in to comment.