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 tracking PR: v12.0.0 #688

Merged
merged 1 commit into from
May 22, 2024

Conversation

tcharding
Copy link
Member

@tcharding tcharding commented May 16, 2024

In preparation for release add a changelog entry and bump the version.

@tcharding
Copy link
Member Author

cc @notmandatory

@tcharding tcharding changed the title Bump version to 12.0.0 Release tracking PR: v12.0.0 May 16, 2024
@tcharding
Copy link
Member Author

@apoelstra and/or @sanket1729 can you guys please look closer than usual at the changelog entries because I don't know what goes on here as closely as I do in other crates, specifically are the sub-headings correct and/or useful? I basically included every merged PR since last release.

Thanks

Copy link
Contributor

@storopoli storopoli left a comment

Choose a reason for hiding this comment

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

Since you've asked for eyes on the changelogs, I've added comments.
Most of these is for consistency throughout the new changelog.

CHANGELOG.md Outdated

- Update MSRV to Rust 1.56.1 [#639](https://github.com/rust-bitcoin/rust-miniscript/pull/639)
- Drop the `Property` trait entirely [#652](https://github.com/rust-bitcoin/rust-miniscript/pull/652)
- Improve compiler logic when deciding between conjunctions and multi/multi_a [#657](https://github.com/rust-bitcoin/rust-miniscript/pull/657)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Improve compiler logic when deciding between conjunctions and multi/multi_a [#657](https://github.com/rust-bitcoin/rust-miniscript/pull/657)
- Improve compiler logic when deciding between conjunctions and `multi`/`multi_a` [#657](https://github.com/rust-bitcoin/rust-miniscript/pull/657)

CHANGELOG.md Outdated
- Drop the `Property` trait entirely [#652](https://github.com/rust-bitcoin/rust-miniscript/pull/652)
- Improve compiler logic when deciding between conjunctions and multi/multi_a [#657](https://github.com/rust-bitcoin/rust-miniscript/pull/657)
- Several locktime improvements [#654](https://github.com/rust-bitcoin/rust-miniscript/pull/654)
- Derives `Hash` for pub items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Derives `Hash` for pub items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)
- Derives `Hash` for `pub` items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)

CHANGELOG.md Outdated
- Drop the `Property` trait entirely [#652](https://github.com/rust-bitcoin/rust-miniscript/pull/652)
- Improve compiler logic when deciding between conjunctions and multi/multi_a [#657](https://github.com/rust-bitcoin/rust-miniscript/pull/657)
- Several locktime improvements [#654](https://github.com/rust-bitcoin/rust-miniscript/pull/654)
- Derives `Hash` for pub items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Derives `Hash` for pub items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)
- Derive `Hash` for pub items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)

Why all other are like "Introduce", "Upgrade", "Return" etc; and this is "Derives"

- Introduce `Threshold` type [#660](https://github.com/rust-bitcoin/rust-miniscript/pull/660),
[#674](https://github.com/rust-bitcoin/rust-miniscript/pull/674),
and [#676](https://github.com/rust-bitcoin/rust-miniscript/pull/676)
- Upgrade `bech32` dependency to `v0.11.0` [#661](https://github.com/rust-bitcoin/rust-miniscript/pull/661)
Copy link
Contributor

Choose a reason for hiding this comment

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

Either this version is non code, i.e. 0.11.0 or the MSRV Rust version above should be as code (backticks) for consistency

CHANGELOG.md Outdated
## Performance/compiled time improvements

- Remove recursion in `semantic` module [#612](https://github.com/rust-bitcoin/rust-miniscript/pull/612)
- Remove generics from Error by making fragment a String [#642](https://github.com/rust-bitcoin/rust-miniscript/pull/642)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Remove generics from Error by making fragment a String [#642](https://github.com/rust-bitcoin/rust-miniscript/pull/642)
- Remove generics from `Error` by making fragment a `String` [#642](https://github.com/rust-bitcoin/rust-miniscript/pull/642)

CHANGELOG.md Outdated

- Remove recursion in `semantic` module [#612](https://github.com/rust-bitcoin/rust-miniscript/pull/612)
- Remove generics from Error by making fragment a String [#642](https://github.com/rust-bitcoin/rust-miniscript/pull/642)
- Remove unused generic on check_witness [#644](https://github.com/rust-bitcoin/rust-miniscript/pull/644)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Remove unused generic on check_witness [#644](https://github.com/rust-bitcoin/rust-miniscript/pull/644)
- Remove unused generic on `check_witness` [#644](https://github.com/rust-bitcoin/rust-miniscript/pull/644)

CHANGELOG.md Outdated
- Remove recursion in `semantic` module [#612](https://github.com/rust-bitcoin/rust-miniscript/pull/612)
- Remove generics from Error by making fragment a String [#642](https://github.com/rust-bitcoin/rust-miniscript/pull/642)
- Remove unused generic on check_witness [#644](https://github.com/rust-bitcoin/rust-miniscript/pull/644)
- Add conditional formatting for Terminal [#651](https://github.com/rust-bitcoin/rust-miniscript/pull/651)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Add conditional formatting for Terminal [#651](https://github.com/rust-bitcoin/rust-miniscript/pull/651)
- Add conditional formatting for `Terminal` [#651](https://github.com/rust-bitcoin/rust-miniscript/pull/651)

CHANGELOG.md Outdated

- Remove `internals` dependency [](https://github.com/rust-bitcoin/rust-miniscript/pull/631)
- Introduce an example binary useful for profiling [#646](https://github.com/rust-bitcoin/rust-miniscript/pull/646)
- Refactor out type_check [#649](https://github.com/rust-bitcoin/rust-miniscript/pull/649)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Refactor out type_check [#649](https://github.com/rust-bitcoin/rust-miniscript/pull/649)
- Refactor out `type_check` [#649](https://github.com/rust-bitcoin/rust-miniscript/pull/649)

@tcharding
Copy link
Member Author

Thanks @storopoli, I'll re-spin with all your suggestions.

@tcharding
Copy link
Member Author

tcharding commented May 17, 2024

Hey @storopoli man, to save you review time (which is precious) I would have accepted "you forgot to back tick all the types". But thanks for taking the time to point each out.

I also discovered a set of empty [] - so that's a win!

@tcharding tcharding marked this pull request as ready for review May 17, 2024 23:32
@tcharding
Copy link
Member Author

All yours @apoelstra - review, ack, merge, tag, and publish please (if the changelog is acceptable).

CHANGELOG.md Outdated
- Improve compiler logic when deciding between conjunctions and `multi`/`multi_a` [#657](https://github.com/rust-bitcoin/rust-miniscript/pull/657)
- Several locktime improvements [#654](https://github.com/rust-bitcoin/rust-miniscript/pull/654)
- Derive `Hash` for `pub` items [#659](https://github.com/rust-bitcoin/rust-miniscript/pull/659)
- Introduce `Threshold` type [#660](https://github.com/rust-bitcoin/rust-miniscript/pull/660),
Copy link
Member

Choose a reason for hiding this comment

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

In 7ddaaf6:

Trailing whitespace, and also a trailing comma.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

\me Puts coin in money jar for not reading diff before pushing

Copy link
Contributor

Choose a reason for hiding this comment

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

That jar is getting full... Reminds me a calculus teacher that had a jar of coins for everytime that a student forgot to add $c$ to an integration procedure 😂

Copy link
Member Author

Choose a reason for hiding this comment

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

I had a swear jar once but it got full so quick I stopped. Now we do 5 pushups each time instead - works way better.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ha! Just did five push ups and said "read your diff" at the top of each one - lets see how it goes.

@apoelstra
Copy link
Member

Should definitely mention #645 which increases the set of allowable scripts.

#660 #674 #678 should get their own section since these are a major breaking change that will probably break anybody who is manually constructing Miniscripts using thresholds.

@tcharding
Copy link
Member Author

Note, I did not rebase on master so this excludes the shellcheck CI job patch.

@tcharding
Copy link
Member Author

Also, added #645 but did not add additional explanation - ok?

@tcharding
Copy link
Member Author

# 12.0.0 - May 17, 2024

- Update MSRV to Rust `v1.56.1` [#639](https://github.com/rust-bitcoin/rust-miniscript/pull/639)
- Remove sketchy `LikelyFalse` error [#645](https://github.com/rust-bitcoin/rust-miniscript/pull/645)

In preparation for release add a changelog entry and bump the version.
@tcharding
Copy link
Member Author

Updated date to 22nd

Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK 5ea33e3

@apoelstra apoelstra merged commit 9e1b3cd into rust-bitcoin:master May 22, 2024
8 checks passed
@apoelstra
Copy link
Member

Tagged and published.

@tcharding tcharding deleted the 05-16-release-12.0.0 branch July 16, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants