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-alpha.4 #1281

Closed
23 tasks done
notmandatory opened this issue Jan 16, 2024 · 0 comments · Fixed by #1282
Closed
23 tasks done

Release 1.0.0-alpha.4 #1281

notmandatory opened this issue Jan 16, 2024 · 0 comments · Fixed by #1282
Assignees
Labels
release Release related issue or PR
Milestone

Comments

@notmandatory
Copy link
Member

notmandatory commented Jan 16, 2024

Create a new minor release

Summary

This bi-weekly alpha release fixes a chain module performance issue, revamps the KeychainTxOutIndex API to be safer, and moves the hardwaresigner module into it's own crate.

Commit

TBD

Changelog

Fixed

Changed

Added

Checklist

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

On the day of the feature freeze

Change the master branch to the 1.0.0-alpha.4 version:

  • Switch to the master branch.
  • Create a new PR branch called bump_dev_1.0.0_alpha.4.
  • Bump the bump_dev_1.0.0_alpha.4 branch to the next development MINOR+1 version.
    • Change the bdk Cargo.toml version value to 1.0.0-alpha.4.
    • Bump the other modified crates versions in their Cargo.toml files.
      • bdk_chain
      • bdk_bitciond_rpc
      • bdk_electrum
      • bdk_esplora
      • bdk_file_store
    • The commit message should be:
      Bump version to 1.0.0-alpha.4
      
      bdk_chain to 0.8.0
      bdk_bitcoind_rpc to 0.3.0
      bdk_electrum to 0.6.0
      bdk_esplora to 0.6.0
      bdk_file_store to 0.4.0
      
  • Create PR and merge the bump_dev_1.0.0-alpha.4 branch to master. Bump version to 1.0.0-alpha.4 #1282
    • Title PR "Bump bdk version to 1.0.0-alpha.4".

On the day of the release

Tag and publish new release:

  • Add a tag to the HEAD commit in the master branch.
    • The tag name should be v1.0.0-alpha.4
    • The first line of the tag message should be "Release 1.0.0-alpha.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.
  • Publish all the updated crates to crates.io.
    • bdk
    • bdk_chain
    • bdk_bitciond_rpc
    • bdk_electrum
    • bdk_esplora
    • bdk_file_store
  • 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-alpha.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 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.
  • Announce the release, using the Summary, on Discord, Twitter and Mastodon.
  • Celebrate 🎉
@notmandatory notmandatory added the release Release related issue or PR label Jan 16, 2024
@notmandatory notmandatory added this to the 1.0.0 milestone Jan 16, 2024
@notmandatory notmandatory added this to BDK Jan 16, 2024
@notmandatory notmandatory moved this to In Progress in BDK Jan 16, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in BDK Jan 18, 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

Successfully merging a pull request may close this issue.

2 participants