Skip to content

Fix documentation of the release process #12337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 16, 2018
Merged

Fix documentation of the release process #12337

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98400e2
Adusted grammar in release script readme.
FlXlT Mar 6, 2018
70dc3bb
Adjusts title and explanation about the release process.
FlXlT Mar 6, 2018
0662481
Merge pull request #1 from delftswa2018/adjust-doc
dalderliesten Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions scripts/release/README.md
View file
Open in desktop
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).