-
Notifications
You must be signed in to change notification settings - Fork 90
Open
Milestone
Description
Create a new major release
Summary
This release introduces saving and reusing wallet configuration, adds support for non-persisted async payjoin, automatic descriptor generator, and shell completions, amongst other improvements.
Commit
Changelog
- Add automatic descriptor generator by @AmosOO7 and @tvpeter in 7d3720e
- Add saving and reusing wallet configuration by @tvpeter in ceb9332
- Add non-persisted async payjoin support by @mehmetefeumit in c6bce58
- Add shell completions command by @va-an in f32fc68
- Refactor sync kyoto client by @Mshehu5 in 974c8d5
- Update continuous_integration and audit workflows by @tvpeter in aba4b95
- Update
--prettyto be used in any position by @va-an in c475363 - Update
bdk_kyototo v0.15.1 by @rustaceanrob in 70617f9 - Update documentation to include installation prerequisite by @tvpeter in 0725724
- Replace coveralls with codecov for coverage reporting by @tvpeter in c475363
- Fix using any client in config test by @tvpeter in af0d98e
- Fix enforcing use of 1.0.0-rc.1 payjoin version by @nymius in 6a2e398
- Fix payjoin documentation by @nymius in a6d22b9
- Fix duplicate wallet creation in non-persistent path by @Mshehu5 in ba5e349
- Fix removing MSRV by @va-an in 4347ea2
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.- 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 🎉
Reactions are currently unavailable