-
-
Notifications
You must be signed in to change notification settings - Fork 142
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
1 parent
d269231
commit 8bf7978
Showing
3 changed files
with
1,388 additions
and
77 deletions.
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 |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Release | ||
|
||
Releases are mostly automated using | ||
[release-it](https://github.com/release-it/release-it/) and | ||
[lerna-changelog](https://github.com/lerna/lerna-changelog/). | ||
|
||
|
||
## Preparation | ||
|
||
Since the majority of the actual release process is automated, the primary | ||
remaining task prior to releasing is confirming that all pull requests that | ||
have been merged since the last release have been labeled with the appropriate | ||
`lerna-changelog` labels and the titles have been updated to ensure they | ||
represent something that would make sense to our users. Some great information | ||
on why this is important can be found at | ||
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall | ||
guiding principle here is that changelogs are for humans, not machines. | ||
|
||
When reviewing merged PR's the labels to be used are: | ||
|
||
* breaking - Used when the PR is considered a breaking change. | ||
* enhancement - Used when the PR adds a new feature or enhancement. | ||
* bug - Used when the PR fixes a bug included in a previous release. | ||
* documentation - Used when the PR adds or updates documentation. | ||
* internal - Used for internal changes that still require a mention in the | ||
changelog/release notes. | ||
|
||
|
||
## Release | ||
|
||
Once the prep work is completed, the actual release is straight forward: | ||
|
||
* First ensure that you have `release-it` installed globally, generally done by | ||
using one of the following commands: | ||
|
||
``` | ||
# using https://volta.sh | ||
volta install release-it | ||
# using Yarn | ||
yarn global add release-it | ||
# using npm | ||
npm install --global release-it | ||
``` | ||
|
||
* Second, ensure that you have installed your projects dependencies: | ||
|
||
``` | ||
yarn install | ||
``` | ||
|
||
* And last (but not least 😁) do your release. It requires a | ||
[GitHub personal access token](https://github.com/settings/tokens) as | ||
`$GITHUB_AUTH` environment variable. Only "repo" access is needed; no "admin" | ||
or other scopes are required. | ||
|
||
``` | ||
export GITHUB_AUTH="f941e0..." | ||
release-it | ||
``` | ||
|
||
[release-it](https://github.com/release-it/release-it/) manages the actual | ||
release process. It will prompt you to to choose the version number after which | ||
you will have the chance to hand tweak the changelog to be used (for the | ||
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging, | ||
pushing the tag and commits, etc. |
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
Oops, something went wrong.