-
Notifications
You must be signed in to change notification settings - Fork 227
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Matt Goo
authored
May 31, 2018
1 parent
67aaef2
commit 983ca89
Showing
3 changed files
with
67 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,3 +10,4 @@ key.json | |
lerna-debug.log | ||
build | ||
dist | ||
packages/**/CHANGELOG.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Release | ||
|
||
|
||
#### Setup Local Environment | ||
> Employees are supposed to do this as part of onboarding, but we've put it here as a reminder. | ||
``` | ||
npm login | ||
``` | ||
|
||
This will log you into NPM. | ||
|
||
#### Announce | ||
Ping the Slack announcements channel first! This will let other members of the team know NOT to merge PRs during this release process. | ||
|
||
|
||
#### Pull | ||
|
||
> Ensure you are on the master branch | ||
``` | ||
git checkout master && git pull --tags | ||
``` | ||
|
||
This will pull the latest of master onto your git clone. | ||
|
||
#### Pre-Release | ||
|
||
``` | ||
./scripts/pre-release.sh | ||
``` | ||
|
||
This will ensure you can publish/tag, build all release files, and ensure all tests pass prior to releasing (lerna will update versions for us in the next step). | ||
|
||
|
||
#### Release | ||
|
||
``` | ||
$(npm bin)/lerna publish --skip-git --conventional-commits | ||
``` | ||
|
||
When lerna prompts for version, just go with it recommends as it uses the [Conventional Changelog Package](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-recommended-bump). | ||
|
||
#### Push | ||
|
||
``` | ||
git push && git push --tags | ||
``` | ||
|
||
This will ensure the commits and tags are pushed to the remote git repository. | ||
|
||
|
||
> If you run into CLI errors such as: | ||
``` | ||
remote: error: GH006: Protected branch update failed for refs/heads/master. | ||
remote: error: Required status check "cla/google" is expected. At least one approved review is required by reviewers with write access. | ||
To github.com:material-components/material-components-web-react.git | ||
! [remote rejected] master -> master (protected branch hook declined) | ||
You may need to update Github's master branch protection: | ||
``` | ||
> 1. Go to: settings page | ||
> 1. Uncheck Include administrators | ||
> 1. Click Save changes | ||
> 1. Perform git push && git push --tags | ||
> 1. Don't forget to toggle on Include administrators & click Save changes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters