-
Notifications
You must be signed in to change notification settings - Fork 75
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.
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
Add automated release setup. #250
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -1,5 +1,3 @@ | ||
# Changelog | ||
|
||
## v1.0.0-beta.2 (2019-11-15) | ||
|
||
#### :rocket: Enhancement | ||
|
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 was deleted.
Oops, something went wrong.
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is removed because all future additions to the changelog are pushed onto the beginning.