-
Notifications
You must be signed in to change notification settings - Fork 88
Closed
Description
Create a new major release
Summary
This release of bdk-cli 1.0.0 uses bdk_wallet 1.0.0 and integrates Kyoto, which uses the Kyoto protocol for compact block filters. It sets SQLite as the default database and drops support for sled.
Commit
Changelog
- Change MSRV to 1.75.0 by @notmandatory in 50a6a60
- change
electrumclient to usebdk_electrum, sqlite feature to usebdk_wallet/rusqliteby @tvpeter in 6f263bf - update
replto useshlexinstead ofregex,rustylineandfd-lockby @notmandatory in 50a6a60 - update
bdk_walletto 1.0.0 by @tvpeter in 6f263bf - update
bdk_bitcoind_rpcto 0.18.0,bdk_electrumto0.21.0,bdk_esplorato 0.20.1,bdk-reservesto 0.29.0 by @tvpeter in 6f263bf - update
electrsdto v31.0 by @tvpeter in 58f07a1 - update
clapto v4.5 by @notmandatory in 50a6a60 - add
cbffeature usingbdk-kyotoby @rustaceanrob in 8ac6957 and @tvpeter in 6debc68 - replace
regtest-bitcoinfeature withrpcby @tvpeter in 8307db0 - add custom error enum by @tvpeter in b8d2357
- sets
replandsqliteas the default features by @notmandatory in 50a6a60 - Set default fee rate to FeeRate::BROADCAST_MIN by @tvpeter in ddce50d
- enable
rbfby default by @tvpeter in 4c89cbf - replace
ExtendedPrivateKeywithXprivby @tvpeter in 4c89cbf - Replace
list_transactionswithtransactionsby @tvpeter in ddce50d - Replace
allow_shringkingwithdrain_tomethods by @tvpeter ddce50d - Replace
Wallet<D>withPersistedWallet<D>by @tvpeter in ddce50d - replace
descriptorCLI parameter withext-descriptorandchangewithint-descriptor - drop support for
sled - Drop
key-value-dbfeature by @tvpeter in b56c023 - drop
esplora-ureq,esplora-reqwest,regtest-bitcoin,regtest-electrum,regtest-nodeandreservesfeatures by @notmandatory in 50a6a60
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
masterbranch. - Create a new PR branch called
bump_dev_MAJOR_MINOR+1, eg.bump_dev_0_22. - Bump the
bump_dev_MAJOR_MINOR+1branch to the next development MINOR+1 version.- Change the
Cargo.tomlversion value toMAJOR.MINOR+1.0. - The commit message should be "Bump version to MAJOR.MINOR+1.0".
- Change the
- Create PR and merge the
bump_dev_MAJOR_MINOR+1branch tomaster. Chore/make release #188- 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
masteris up-to-date with the upstream repo. - Create a new branch called
release/MAJOR.MINOR+1frommaster. - Add a tag to the
HEADcommit in therelease/MAJOR.MINOR+1branch.- 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
--signflag.
- The tag name should be
- Wait for the CI to finish one last time.
- Push the new tag to the
bitcoindevkit/bdk-clirepo. - 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 🎉
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Done