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.

Sign up for GitHub

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

Jump to bottom

Release 1.0.0-alpha.2 #1168

Closed
12 tasks done
notmandatory opened this issue Oct 11, 2023 · 0 comments
Closed
12 tasks done

Release 1.0.0-alpha.2 #1168

notmandatory opened this issue Oct 11, 2023 · 0 comments
Assignees
@notmandatory
Labels
release Release related issue or PR
Milestone
1.0.0-alpha.2

Comments

@notmandatory
Copy link
Member

notmandatory commented Oct 11, 2023 •
edited
Loading

Create a new minor release

Summary

Notable changes include a new bitcoind RPC based blockchain client module for quick syncing to bitcoind, a new linked-list LocalChain, and an upgrade to rust-bitcoin 0.30.

Commit

6ebdd19

Changelog

Fixed

Added

Changed

Checklist

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

On the day of the release

Update the master branch with to version 1.0.0-alpha.2:

  • Switch to the master branch.
  • Create a new PR branch called bump_dev_1_0_alpha_2.
  • Bump the bump_dev_1_0_alpha_2 branch to the next development MINOR+1 version.
    • Change the bdk Cargo.toml version value to 1.0.0-alpha.2.
    • Change the bdk_chain Cargo.toml version to 0.6.0.
    • Change the bdk_electrum Cargo.toml version to 0.4.0.
    • Change the bdk_esplora Cargo.toml version to 0.4.0.
    • Update the CHANGELOG.md file.
    • The commit message should be: 
      Bump bdk version to 1.0.0-alpha.2

Bump bdk_chain to 0.6.0
Bump bdk_electrum to 0.4.0
Bump bdk_esplora to 0.4.0
  • Create PR and merge the bump_dev_1_0_alpha_2 branch to master.
    • Title PR "Bump version to 1.0.0-alpha.2".

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.2
    • The first line of the tag message should be "Release 1.0.0-alpha.2".
    • 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.
  • 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.2.
    • 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 Oct 11, 2023
@notmandatory notmandatory added this to the 1.0.0-alpha.2 milestone Oct 11, 2023
@notmandatory notmandatory self-assigned this Oct 11, 2023
@notmandatory notmandatory added this to BDK Oct 11, 2023
@notmandatory notmandatory moved this to In Progress in BDK Oct 11, 2023
@notmandatory notmandatory mentioned this issue Oct 11, 2023
Merged
@notmandatory notmandatory moved this from In Progress to Needs Review in BDK Oct 12, 2023
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@notmandatory notmandatory

Labels
release Release related issue or PR
Projects
BDK
Archived in project
Milestone
1.0.0-alpha.2
Development

No branches or pull requests
2 participants
@notmandatory and others