-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
devtools: document and further automate release process (#112)
* feat: version bump and changelog automation * Automatically commit and open pr * Add release docs * Mention gh * Remove reviewers
- Loading branch information
Daniel
authored
Feb 18, 2022
1 parent
2c2d228
commit b104cbf
Showing
4 changed files
with
40 additions
and
4 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 @@ | ||
git-tag-version = false |
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,36 @@ | ||
# Release Process | ||
|
||
This documents our release process. | ||
|
||
## Update the Code | ||
|
||
Checkout `master` and make sure to pull all the latest changes that sould be included in the release. | ||
|
||
## Bump the Version | ||
|
||
Use [`npm version`](https://docs.npmjs.com/cli/v6/commands/npm-version) to bump the version and update the changelog. | ||
Most of the time you will want to run: | ||
|
||
``` | ||
npm version <patch|minor|major> | ||
``` | ||
|
||
For more details and other possible release types see [the npm docs](https://docs.npmjs.com/cli/v6/commands/npm-version). | ||
|
||
This will: | ||
|
||
1. Create and checkout a branch for the release preparation: `prepare-v<new-version>-<timestamp>` | ||
1. Bump the version in `package.json` and `package.lock.json` | ||
1. Update the changelog | ||
1. Commit the changes and push the branch | ||
1. If you have the [GitHub CLI](https://cli.github.com/) installed it will automatically open a _draft_ pull request to `master` | ||
|
||
## Merge the Release Pull Request | ||
|
||
This is a good point to clean up the changelog if needed and get feedback on the release. | ||
When everyone is happy with the release, merge the pull request to `master`. | ||
|
||
## Tag the Release | ||
|
||
Back on `master`, tag the release and based on the new tag crate a release on GitHub. | ||
This is a step we might automate completely via GitHub Actions in the future. |
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
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