Skip to content

Bump library version + add changelog - #1112

Merged
thunderbiscuit merged 2 commits into
bitcoindevkit:release/3.1from
thunderbiscuit:release/3.1
Sep 4, 2026
Merged

thunderbiscuit merged 2 commits into
bitcoindevkit:release/3.1from
thunderbiscuit:release/3.1

Conversation

@thunderbiscuit

Copy link
Copy Markdown
Member

This PR bumps the libraries to their release versions and adds the changelog entry for 3.1

@reez reez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two nits, otherwise good!

Comment thread CHANGELOG.md Outdated
@@ -6,6 +6,56 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased](https://github.com/bitcoindevkit/bdk-ffi/compare/v3.0.0...HEAD)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this get changed to [Unreleased](https://github.com/bitcoindevkit/bdk-ffi/compare/v3.1.0...HEAD) ?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep thanks!

Comment thread CHANGELOG.md Outdated

### Added

- Add `timeout` and `retry` argument on Electrum client builder [#1010]

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this, nothing is wrong with the automated changelog, but the background for this is I asked to squeeze it into the 3.0.0 last minute #1010 (comment) and then it sort of overlapped a bit with the general addition of the automated changelog label stuff

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes I see. Cool!

@thunderbiscuit

Copy link
Copy Markdown
Member Author

I'll wait and merge #1113 first, then rebase this branch onto master and merge then.

@reez

reez commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

I'll wait and merge #1113 first, then rebase this branch onto master and merge then.

Cool, just ACK'd 1113

@thunderbiscuit

Copy link
Copy Markdown
Member Author

@reez would you mind taking another look at this one? That'll set me up for cutting and pushing the tag.

Comment thread CHANGELOG.md
- Add public descriptor conversion [#1054]
- Expose extract_tx_with_fee_rate_limit and extract_tx_unchecked_fee_rate on Psbt [#1056]

### Fixed

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we include the Psbt::finalize fix from #1015 and the foreign-UTXO validation change from #1030 in this section? Both are part of the 3.1 release diff and affect observable behavior; #1015 is also labeled changelog: fixed and explicitly provided a release-note entry.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will reply on the main thread!

@reez

reez commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

@reez would you mind taking another look at this one? That'll set me up for cutting and pushing the tag.

ACK with this comment: For #1015 and #1030 it looks like they were generated by the changelog automation I think but you removed them so I’m assuming you did that for a specific reason so up to you if you want to add them back in or not?

@thunderbiscuit

Copy link
Copy Markdown
Member Author

Sorry guys I removed those from the auto-generated notes because they were not quite changelog worthy at first glance (the auto-generation only grabs the PR title and puts it in the category defined by the label).

  • Bumping miniscript to a patch is not a line in the changelog directly, it should come in in the header-type section where we define the libraries' versions directly. Miniscript is not in this group at the moment, but I think it would actually be worth adding. A worthy changelog line IMO has to be something specific that was fixed, not the bump itself. This is the case here indeed, and I just didn't realize so apologies for that. I'll add it for sure!
  • Same for 1030. Reading it I thought it was just the bump in bdk_wallet to 3.1.0, but actually the PR contained a small fix as well. I'll update the changelog.

Note that we could also decide that important library version updates should come into the ## Added section as well as individual entries. We just haven't done that in the past.

@reez

reez commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

Sorry guys I removed those from the auto-generated notes because they were not quite changelog worthy at first glance (the auto-generation only grabs the PR title and puts it in the category defined by the label).

  • Bumping miniscript to a patch is not a line in the changelog directly, it should come in in the header-type section where we define the libraries' versions directly. Miniscript is not in this group at the moment, but I think it would actually be worth adding. A worthy changelog line IMO has to be something specific that was fixed, not the bump itself. This is the case here indeed, and I just didn't realize so apologies for that. I'll add it for sure!

  • Same for 1030. Reading it I thought it was just the bump in bdk_wallet to 3.1.0, but actually the PR contained a small fix as well. I'll update the changelog.

Note that we could also decide that important library version updates should come into the ## Added section as well as individual entries. We just haven't done that in the past.

Sounds good, got my ACK so feel free to merge whenever you're ready

@thunderbiscuit

Copy link
Copy Markdown
Member Author

@j-kon @reez thanks for the review guys!

@thunderbiscuit
thunderbiscuit merged commit 5fa4898 into bitcoindevkit:release/3.1 Sep 4, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants