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 1.0.0-beta.4 #1609

Closed
34 of 38 tasks
notmandatory opened this issue Sep 13, 2024 · 0 comments
Closed
34 of 38 tasks

Release 1.0.0-beta.4 #1609

notmandatory opened this issue Sep 13, 2024 · 0 comments
Assignees
Labels
release Release related issue or PR
Milestone

Comments

@notmandatory
Copy link
Member

notmandatory commented Sep 13, 2024

Create a new major (beta) release

Summary

BDK Wallet 1.0.0-beta.4 replaces 1.0.0-beta.3 and fixes a versioning mistake with two of our dependency crates. The bdk-wallet 1.0.0-beta.3 version and related dependency patch releases have been yanked from crates.io.

Commit

TBD

Changelog

See https://github.com/bitcoindevkit/bdk/releases/tag/v1.0.0-beta.3

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current master branch development version is 1.0.0-beta.3.

On the day of the feature freeze

Change the master branch to the 1.0.0-beta.4 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_beta.4.
  • Create a "draft" release page and release notes comparing master commmit with prior tag v1.0.0-beta.3
  • Bump the bump_dev_1.0.0_beta.4 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
    • The commit message should be: [update this list with only changed crates]
      Bump bdk_wallet version to 1.0.0-beta.4
      
      bdk_core to 0.2.0
      bdk_chain to 0.19.0
      bdk_bitcoind_rpc to 0.15.0
      bdk_electrum to 0.18.0
      bdk_esplora to 0.18.0
      bdk_file_store to 0.16.0
      bdk_testenv to 0.9.0
      
  • Create PR and merge the release/bump_dev_1.0.0-beta.4 branch to master. Bump bdk_wallet version to 1.0.0-beta.4 #1610
    • Title PR "Bump bdk_wallet version to 1.0.0-beta.4".

On the day of the release

Tag and publish new release:

  • Add a tag to the HEAD commit in the master branch.
    • git tag v1.0.0-beta.4 --sign -e
    • The tag name should be v1.0.0-beta.4
    • The first line of the tag message should be "Release 1.0.0-beta.4".
    • 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 repo.
    • git push upstream --tag v1.0.0-beta.4
  • 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 1.0.0-beta.4.
    • 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 final 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.
  • Yank invalid versions from beta.4 release.
    • bdk_core to 0.1.1
    • bdk_chain to 0.18.1
    • bdk_bitcoind_rpc to 0.14.1
    • bdk_electrum to 0.17.1
    • bdk_esplora to 0.17.1
    • bdk_file_store to 0.15.1
    • bdk_testenv to 0.8.1
  • Announce the release, using the Summary, on Discord, Twitter and Nostr.
  • Celebrate 🎉
@notmandatory notmandatory added the release Release related issue or PR label Sep 13, 2024
@notmandatory notmandatory self-assigned this Sep 13, 2024
@notmandatory notmandatory added this to BDK Sep 13, 2024
@notmandatory notmandatory moved this to In Progress in BDK Sep 13, 2024
@notmandatory notmandatory added this to the 1.0.0-beta milestone Sep 13, 2024
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Sep 14, 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