Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release wallet-1.0.0 FINAL #1783

Closed
40 tasks done
notmandatory opened this issue Dec 18, 2024 · 1 comment
Closed
40 tasks done

Release wallet-1.0.0 FINAL #1783

notmandatory opened this issue Dec 18, 2024 · 1 comment
Assignees
Labels
release Release related issue or PR
Milestone

Comments

@notmandatory
Copy link
Member

notmandatory commented Dec 18, 2024

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

03a08bb

Changelog

Changed

Documentation

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
      
  • Create PR and merge the release/bump_dev_1.0.0 branch to master.

On the day of the release

Tag and publish new release:

  • Add a tag to the HEAD commit in the master 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 🎉
@notmandatory notmandatory added the release Release related issue or PR label Dec 18, 2024
@notmandatory notmandatory added this to the 1.0.0-beta milestone Dec 18, 2024
@notmandatory notmandatory self-assigned this Dec 18, 2024
@notmandatory notmandatory added this to BDK Dec 18, 2024
@notmandatory notmandatory changed the title Release 1.0.0 FINAL Release wallet-1.0.0 FINAL Dec 19, 2024
@notmandatory notmandatory moved this to In Progress in BDK Dec 19, 2024
@notmandatory
Copy link
Member Author

notmandatory commented Dec 19, 2024

More details to use in announcement:

"Initial commit" on github was made on Jan 22, 2020.

Since then:

  • 79 individual contributors
  • 2264 git commits
  • 14289 lines of code with 83.9 % test coverage

On GitHub:

On crates.io, all-time downloads:

@github-project-automation github-project-automation bot moved this from In Progress to Done in BDK Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release Release related issue or PR
Projects
Archived in project
Development

No branches or pull requests

1 participant