-
Notifications
You must be signed in to change notification settings - Fork 435
Description
Summary
<--release summary to be used in announcements-->
Commit
<--latest commit ID to include in this release-->
Changelog
- fix(ci): backport
webpki-rootspinned version and clippy fixes #2061 - chore(ci): pin
proptestto1.8.0on1.75.0MSRV #2075 - feat(chain): add new
list_ordered_canonical_txsmethod #2027 chain 0.23.x: Fix panic in scan loop and update msrv and esplora-client #2148- fix(ci): pin toolchain, and switch to
actions-rust-lang/setup-rust-toolchain#2151 chain 0.23.x: FixChainPositionordering #2146chain 0.23.x: forwardconfirmation_height_upper_boundinAnchorimplementation for&A#2149chain 0.23.x: Fix assumed canonical tx always being unconfirmed #2150
Checklist
Release numbering must follow Semantic Versioning. These steps assume the current master
branch development version is 0.23.3.
On the day of the feature freeze
Change the release/chain-0.23.x branch to the next MINOR+1 version:
- Switch to the
release/chain-0.23.xbranch. - Create a new PR branch called
release/chain-0.23.3. - Bump the
release/chain-0.23.3branch to the next development MINOR+1 version.- Change the
Cargo.tomlversion value to0.23.3. - Update the
CHANGELOG.mdfile. - The commit message should be "chore(release): bump
bdk_chainto0.23.3".
- Change the
- Create PR and merge the
release/chain-0.23.3branch tomaster.- Title PR "chore(release): bump
bdk_chainto0.23.3".
- Title PR "chore(release): bump
Create a new release branch and release candidate tag:
- Double check that your local
release/chain-0.23.xis up-to-date with the upstream repo. - Create a new branch called
release/chain-0.23.3fromrelease/chain-0.23.x. - Bump the
release/chain-0.23.xbranch to0.23.3version.- Change the
Cargo.tomlversion value to0.23.3. - The commit message should be "chore(release): bump
bdk_chainto0.23.3".
- Change the
- Add a tag to the
HEADcommit in therelease/chain-0.23.xbranch.- The tag name should be
chain-0.23.3 - Use message "Release chain-0.23.3".
- Make sure the tag is signed, for extra safety use the explicit
--signflag.
- The tag name should be
- Push the
release/chain-0.23.3branch and new tag to thebitcoindevkit/bdkrepo.- Use
git push --tagsoption to push the newchain-0.23.3tag.
- Use
If any issues need to be fixed before the MAJOR.MINOR+1.0 version is released:
- Merge fix PRs to the
masterbranch. - Git cherry-pick fix commits to the
release/MAJOR.MINOR+1branch. - Verify fixes in
release/MAJOR.MINOR+1branch. - Bump the
release/MAJOR.MINOR+1branch toMAJOR.MINOR+1.0-rc.x+1version.- Change the
Cargo.tomlversion value toMAJOR.MINOR+1.0-rc.x+1. - The commit message should be "Bump version to MAJOR.MINOR+1.0-rc.x+1".
- Change the
- Add a tag to the
HEADcommit in therelease/MAJOR.MINOR+1branch.- The tag name should be
vMAJOR.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
--signflag.
- The tag name should be
- Push the new tag to the
bitcoindevkit/bdkrepo.- Use
git push --tagsoption to push the newvMAJOR.MINOR+1.0-rc.x+1tag.
- Use
On the day of the release
Tag and publish new release:
- Bump the
release/chain-0.23.xbranch to0.23.3version.- Change the
Cargo.tomlversion value to0.23.3. - The commit message should be "chore(release): bump
bdk_chainto0.23.3".
- Change the
- Add a tag to the
HEADcommit in therelease/chain-0.23.xbranch.- The tag name should be
chain-0.23.x - The first line of the tag message should be "Release chain-0.23.3".
- 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
--signflag.
- The tag name should be
- Wait for the CI to finish one last time.
- Push the new tag to the
bitcoindevkit/bdkrepo. - Publish all the updated 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 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.0release 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 and Mastodon.
- Celebrate 🎉
Reactions are currently unavailable
Sub-issues
Metadata
Metadata
Assignees
Labels
releaseRelease related issue or PRRelease related issue or PR
Type
Projects
Status
In Progress