Skip to content

Release 0.28.1 #1056

@notmandatory

Description

@notmandatory

Create a new patch release

Summary

This patch release backports (from the BDK 1.0 dev branch) a fix for a bug in the policy condition calculation and adds a new taproot single key descriptor template (BIP-86). The policy condition calculation bug can cause issues when a policy subtree fails due to missing info even if it's not selected when creating a new transaction, errors on unused policy paths are now ignored.

Commit

7231039

Changelog

Fixed

Added

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current release/0.28
branch development version is 0.28.0.

On the day of the patch release

Change the master branch to the new PATCH+1 version:

  • Switch to the release/0.28 branch.
  • Create a new PR branch called bump_dev_0_28_1.
  • Bump the bump_dev_0_28_1 branch to the next development 0.28.1 version.
    • Change the Cargo.toml version value to 0.28.1.
    • Update the CHANGELOG.md file.
    • The commit message should be "Bump version to 0.28.1".
  • Create PR and merge the bump_dev_0_28_1 branch to release/0.28.
    • Title PR "release: bump version to 0.28.1".

Cherry-pick, tag and publish new PATCH+1 release:

  • Add a tag to the HEAD commit in the release/0.28 branch.
    • The tag name should be v0.28.1
    • The first line of the tag message should be "Release 0.28.1".
    • 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 bitcoindevkit/bdk repo.
  • 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 0.28.1.
    • 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 and Mastodon.
  • Celebrate 🎉

Metadata

Metadata

Assignees

Labels

releaseRelease related issue or PR

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions