Skip to content

Commit 5712e52

Browse files
[added] Documentation for release process
1 parent 015b224 commit 5712e52

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Releasing #
2+
3+
To push a new build to NPM, follow these steps. If the process changes, please update this doc. :smiley:
4+
5+
1. Ensure that all local changes have been uploaded to GitHub.
6+
2. Verify that [continuous integration](https://circleci.com/gh/material-motion/material-motion-js) is passing.
7+
3. Build each package. (`yarn run build` in the repo root.)
8+
1. Verify there are no build/lint warnings. If there are, fix them, and go back to step 1.
9+
2. Smoke test `demos-react`.
10+
- `yarn run serve` it, and ensure the interactions all work as expected.
11+
2. Smoke test them in a separate project that uses Material Motion.
12+
1. Replace the project's copy of the `material-motion` packages with the built artifacts.
13+
2. Serve the project, and ensure the interactions still work as expected.
14+
3. Read each README, and ensure its information is current.
15+
4. Verify that each package's `.npmignore` is correct.
16+
5. Update the version number:
17+
- In `lerna.json`.
18+
- In each package's README:
19+
- In the NPM badge.
20+
- In the `<script>` tag example, if there is one.
21+
6. Update the CHANGELOG.
22+
7. Commit the README and CHANGELOG updates as `[release] v#.#.#`, and upload the commit.
23+
8. `lerna publish`
24+
9. `yarn run deploy` in `demos-react`. Check that http://material-motion-demos.firebaseapp.com still works correctly.
25+
10. Delete the `material-motion` packages in the test project and run `yarn` again to pull the published version from NPM. Smoke test it again to validate that the deployed version works correctly.
26+
11. Look at the published packages on [npmjs.com](https://www.npmjs.com/package/material-motion), and verify the versions and READMEs look correct.
27+
12. Update the `stable` branch:
28+
```
29+
git checkout stable
30+
git reset --hard develop
31+
git push origin stable
32+
```

0 commit comments

Comments
 (0)