Closed
Description
Summary
This is the final bdk_wallet 1.0.0 release. It contains small improvements to the wallet transactions
function and
next_unused_address
API docs. Please thank all the contributors who made this first major release possible and who's continued effort make the BDK project so awesome!
Commit
Changelog
Changed
Wallet::transactions
should only return relevant transactions.transactions
method should only return relevant transactions #1779- Minor updates to fix new rustc 1.83.0 clippy warnings. ci: automated update to rustc 1.83.0 #1776
Documentation
- Reword the
next_unused_address
API docs. docs(wallet): reword thenext_unused_address
doc #1680
Checklist
Release numbering must follow Semantic Versioning. These steps assume the current master
branch development version is v1.0.0-beta.6.
On the day of the feature freeze
Change the master
branch to the next MINOR+1 version:
- Ensure all alpha milestone issues and PRs closed, archive them on the project board.
- Switch to the
master
branch. - Create a new PR branch called
release/bump_dev_1.0.0
. - Create a "draft" release page and release notes comparing master commit with prior tag
v1.0.0-beta.6
- Determine which crates need a major release bump and which only need a patch release by looking at the git log.
cargo-semver-checks
can also help with this
cargo semver-checks --baseline-rev <last-tag>
- Bump the
bump_dev_1.0.0
branch to the next development version.- Bump the modified crates versions in their
Cargo.toml
files. [update this list with only changed crates]- bdk_core
- bdk_chain
- bdk_bitcoind_rpc
- bdk_electrum
- bdk_esplora
- bdk_file_store
- bdk_testenv
- bdk_wallet
- For crates that changed update their
CHANGELOG.md
files, see "keep a changelog". - The commit message should be: [update this list with only changed crates]
Bump bdk_wallet version to 1.0.0 bdk_core to 0.4.1 bdk_chain to 0.21.1 bdk_bitcoind_rpc to 0.17.1 bdk_electrum to 0.20.1 bdk_esplora to 0.20.1 bdk_file_store to 0.18.1 bdk_testenv to 0.11.1
- Bump the modified crates versions in their
- Create PR and merge the
release/bump_dev_1.0.0
branch tomaster
.- Title PR "Bump bdk_wallet version to 1.0.0". Bump bdk_wallet version to 1.0.0 #1784
On the day of the release
Tag and publish new release:
- Add a tag to the
HEAD
commit in themaster
branch.git tag wallet-1.0.0 --sign -e
- The tag name should be
wallet-1.0.0
- The first line of the tag message should be "Release wallet-1.0.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.
- Verify the new tag with
git tag -v wallet-1.0.0
- Add similar tags for other crates that changed versions.
- core-0.4.1
- chain-0.21.1
- bitcoind_rpc-0.17.1
- electrum-0.20.1
- esplora-0.20.1
- file_store-0.18.1
- testenv-0.11.1
- Wait for the CI to finish one last time.
- Push the new tags to the
bitcoindevkit/bdk
repo.git push upstream --tags
- Publish all the updated crates to crates.io. [update this list with only changed crates]
cargo publish -p <crate name>
- bdk_core
- bdk_chain
- bdk_testenv
- bdk_bitcoind_rpc
- bdk_electrum
- bdk_esplora
- bdk_file_store
- bdk_wallet
- Create the release on GitHub.
- Go to "tags", click on the dots on the right and select "Create Release".
- Set the title to
Release wallet-1.0.0
. - In the release notes body put the Summary and Changelog.
- Use the "+ Auto-generate release notes" button to add details from included PRs.
- This is the final
1.0.0
release, do not 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 releases, using the Summary, on Discord, Twitter and Nostr.
- Celebrate 🎉
Metadata
Metadata
Assignees
Type
Projects
Status
Done