forked from payjoin/rust-payjoin
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add minor release issue template checklist (payjoin#150)
I've overlooked some things publishing bumps in the past. In particular I missed adding proper crate metadata and ensuring rustdocs were right before publishing the release. A checklist seems like a great way to solve this problem. Thanks @bitcoindevkit for the inspiration
- Loading branch information
Showing
1 changed file
with
98 additions
and
0 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,98 @@ | ||
| --- | ||
| name: Minor Release | ||
| about: Checklist for releasing a new minor version bump | ||
| title: Release MAJOR.MINOR+1.0 | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| ## Create a new minor release | ||
|
|
||
| ### Summary | ||
|
|
||
| <--release summary to be used in announcements--> | ||
|
|
||
| ### Commit | ||
|
|
||
| <--latest commit ID to include in this release--> | ||
|
|
||
| ### Changelog | ||
|
|
||
| <--add notices from PRs merged since the prior release, see ["keep a changelog"]--> | ||
|
|
||
| ### Checklist | ||
|
|
||
| Release numbering must follow [Semantic Versioning]. These steps assume the current `master` | ||
| branch **development** version is *MAJOR.MINOR.0*. | ||
|
|
||
| #### On the day of the feature freeze | ||
|
|
||
| Change the `master` branch to the next MINOR+1 version: | ||
|
|
||
| - [ ] Switch to the `master` branch. | ||
| - [ ] Create a new PR branch called `bump-dev-MAJOR-MINOR+1`, eg. `bump-dev-0-22`. | ||
| - [ ] Bump the `bump-dev-MAJOR-MINOR+1` branch to the next development MINOR+1 version. | ||
| - Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0`. | ||
| - Update the `CHANGELOG.md` file. | ||
| - The commit message should be "Bump version to MAJOR.MINOR+1.0". | ||
| - [ ] Create PR and merge the `bump-dev-MAJOR-MINOR+1` branch to `master`. | ||
| - Title PR "Bump version to MAJOR.MINOR+1.0". | ||
|
|
||
| Create a new release branch and release candidate tag: | ||
|
|
||
| - [ ] Double check that your local `master` is up-to-date with the upstream repo. | ||
| - [ ] Create a new branch called `release/MAJOR.MINOR+1` from `master`. | ||
| - [ ] Bump the `release/MAJOR.MINOR+1` branch to `MAJOR.MINOR+1.0-rc.1` version. | ||
| - Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0-rc.1`. | ||
| - The commit message should be "Bump <CRATE> version to MAJOR.MINOR+1.0-rc.1". | ||
| - [ ] Add a tag to the `HEAD` commit in the `release/<CRATE>-MAJOR.MINOR+1` branch. | ||
| - The tag name should be `<CRATE>-MAJOR.MINOR+1.0-rc.1` | ||
| - Use message "Release <CRATE>-MAJOR.MINOR+1.0 rc.1". | ||
| - Make sure the tag is signed, for extra safety use the explicit `--sign` flag. | ||
| - [ ] Push the `release/<CRATE>-MAJOR.MINOR` branch and new tag to the `payjoin/rust-payjoin` repo. | ||
| - Use `git push --tags` option to push the new `<CRATE>-MAJOR.MINOR+1.0-rc.1` tag. | ||
|
|
||
| If any issues need to be fixed before the *MAJOR.MINOR+1.0* version is released: | ||
|
|
||
| - [ ] Merge fix PRs to the `master` branch. | ||
| - [ ] Git cherry-pick fix commits to the `release/<CRATE>-MAJOR.MINOR+1` branch. | ||
| - [ ] Verify fixes in `release/<CRATE>-MAJOR.MINOR+1` branch. | ||
| - [ ] Bump the `release/<CRATE>-MAJOR.MINOR+1` branch to `MAJOR.MINOR+1.0-rc.x+1` version. | ||
| - Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0-rc.x+1`. | ||
| - The commit message should be "Bump version to MAJOR.MINOR+1.0-rc.x+1". | ||
| - [ ] Add a tag to the `HEAD` commit in the `release/<CRATE>-MAJOR.MINOR+1` branch. | ||
| - The tag name should be `<CRATE>-MAJOR.MINOR+1.0-rc.x+1`, where x is the current release candidate number. | ||
| - Use tag message "Release MAJOR.MINOR+1.0 rc.x+1". | ||
| - Make sure the tag is signed, for extra safety use the explicit `--sign` flag. | ||
| - [ ] Push the new tag to the `payjoin/rust-payjoin` repo. | ||
| - Use `git push --tags` option to push the new `<CRATE>-MAJOR.MINOR+1.0-rc.x+1` tag. | ||
|
|
||
| #### On the day of the release | ||
|
|
||
| Tag and publish new release: | ||
|
|
||
| - [ ] Bump the `release/<CRATE>-MAJOR.MINOR+1` branch to `MAJOR.MINOR+1.0` version. | ||
| - Change the `Cargo.toml` version value to `MAJOR.MINOR+1.0`. | ||
| - The commit message should be "Bump <CRATE> version to MAJOR.MINOR+1.0". | ||
| - [ ] Add a tag to the `HEAD` commit in the `release/MAJOR.MINOR+1` branch. | ||
| - The tag name should be `<CRATE>-MAJOR.MINOR+1.0` | ||
| - The first line of the tag message should be "Release <CRATE>-MAJOR.MINOR+1.0". | ||
| - In the body of the tag message put a copy of the **Summary** and **Changelog** for the release. | ||
| - Make sure the tag is signed, for extra safety use the explicit `--sign` flag. | ||
| - [ ] Wait for the CI to finish one last time. | ||
| - [ ] Push the new tag to the `payjoin/rust-payjoin` repo. | ||
| - [ ] Build the docs locally to ensure they are building correctly. | ||
| - [ ] Publish the crate in question crates to crates.io. | ||
| - [ ] Create the release on GitHub. | ||
| - Go to "tags", click on the dots on the right and select "Create Release". | ||
| - Set the title to `Release <CRATE>-MAJOR.MINOR+1.0`. | ||
| - In the release notes body put the **Summary** and **Changelog**. | ||
| - Use the "+ Auto-generate release notes" button to add details from included PRs. | ||
| - Until we reach a `1.0.0` release check the "Pre-release" box. | ||
| - [ ] Make sure the new release shows up on [crates.io] and that the docs are built correctly on [docs.rs]. | ||
| - [ ] Announce the release, using the **Summary**, on Discord, Twitter, Nostr, and stacker.news. | ||
| - [ ] Celebrate 🎉 | ||
|
|
||
| [Semantic Versioning]: https://semver.org/ | ||
| ["keep a changelog"]: https://keepachangelog.com/en/1.0.0/ |