Skip to content

Release bdk-cli 2.0.0 #215

@tvpeter

Description

@tvpeter

Create a new major release

Summary

This release updates bdk_wallet to 2.1.0, adds Taproot descriptor support, and introduces --pretty output formatting. It also adds redb as an alternative database option, improves bdk_kyoto transaction handling, and includes new tooling and examples for easier regtest workflows.

Commit

Changelog

  • Update tracing_subscriber to 0.3.20 by @tvpeter in 4810403
  • Update bdk_wallet to 2.1.0, bdk_bitcoind_rpc to 0.21.0, bdk_esplora to 0.22.1 and bdk_kyoto to 0.13.1 by @tvpeter in 7625422
  • Add top-level flag --pretty to format output in a human-readable format by @tvpeter in 1cadf63
  • Remove MSRV for bdk-cli by @tvpeter in 126d98b
  • Add tr script type to compile command to support creating taproot descriptors by @va-an in 3bcec61
  • add redb as an alternative persistence to sqlite by @110CodingP in 7bcbcf0
  • Remove connection requirement for sending transactions in bdk_kyoto by @rustaceanrob in 3b60b7b
  • Add just example for starting, connecting and funding a wallet in regtest by @tvpeter in 2524da3
  • Add just command runner for common commands and regtest bitcoind by @tvpeter in ef84b92
  • Update bdk_wallet to 2.0.0, bdk_bitcoind_rpc to 0.20.0, bdk_electrum to 0.23.0, bdk_esplora to 0.22.0 and bdk_kyoto to 0.11.0 by @notmandatory in bd526bd
  • Rename BuilderError to KyotoBuilderError and added KyotoUpdateError by @notmandatory in bd526bd

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.
    • 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".

On the day of the release

Tag and publish new release:

  • 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.
  • Add a tag to the HEAD commit in the release/MAJOR.MINOR+1 branch.
    • The tag name should be vMAJOR.MINOR+1.0
    • The first line of the tag message should be "Release 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 bitcoindevkit/bdk-cli 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 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 and Mastodon.
  • Celebrate 🎉

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions