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.3 #1254

Closed
12 tasks done
notmandatory opened this issue Jan 3, 2024 · 1 comment
Closed
12 tasks done

Release 1.0.0-alpha.3 #1254

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

Comments

@notmandatory
Copy link
Member

notmandatory commented Jan 3, 2024

Create a new minor release

Summary

This release changes LocalChain to have a hard-wired genesis block, adds context specific Wallet TxBuilder errors, and bumps the projects MSRV to 1.63. It also includes other API and docs improvements and bug fixes, see the changelog for all the details.

Commit

TBD

Changelog

Fixed

Changed

Removed

Added

Checklist

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

On the day of the feature freeze

Change the master branch to the next MINOR+1 version:

  • Switch to the master branch.
  • Create a new PR branch called bump_dev_1.0.0_alpha.3.
  • Bump the bump_dev_1.0.0_alpha.3 branch to the next development MINOR+1 version.
    • Change the bdk Cargo.toml version value to 1.0.0-alpha.3.
    • Bump the modified crate (bitcoind_rpc, chain, and electrum) versions in their Cargo.toml files.
    • The commit message should be "Bump version to 1.0.0-alpha.3".
  • Create PR and merge the bump_dev_1.0.0-alpha.3 branch to master. Bump bdk version to 1.0.0-alpha.3 #1255
    • Title PR "Bump bdk version to 1.0.0-alpha.3".

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.3
    • The first line of the tag message should be "Release 1.0.0-alpha.3".
    • 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.3.
    • 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 3, 2024
@notmandatory notmandatory added this to the 1.0.0-alpha.3 milestone Jan 3, 2024
@notmandatory notmandatory self-assigned this Jan 3, 2024
@nondiremanuel nondiremanuel modified the milestones: 1.0.0-alpha.3, 1.0.0 Jan 6, 2024
@notmandatory notmandatory modified the milestones: 1.0.0, 1.0.0-alpha.3 Jan 6, 2024
notmandatory added a commit that referenced this issue Jan 7, 2024
0032711 Bump bdk version to 1.0.0-alpha.3 (Steve Myers)

Pull request description:

  ### Description

  - Bump bdk version to 1.0.0-alpha.3
  - Bump bdk_chain to 0.7.0
  - Bump bdk_bitcoin_rpc to 0.2.0
  - Bump bdk_electrum to 0.5.0

  ### Notes to the reviewers

  ### Changelog notice

  See #1254

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

ACKs for top commit:
  evanlinjin:
    ACK 0032711

Tree-SHA512: ac0756f52436880fe633e9ecb83f3d53f485ccfa89a3a89aa51ee4ba5da5cee87f507da69a9e1271f8aaf4425f65d04fb201ea9a4f64bce18f96039ea3548d61
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

2 participants