Release payjoin 0.23

[spacebear21]

Create a new minor release

Summary

This release features a first-class persistence abstraction, wire protocol changes for RFC 9540 support, and better compliance with the BIP78 specification. It also pays back a whole bunch of tech debt including enhanced error handling, expanded functionality with new modules and additive features, and improved test infrastructure. There are breaking API and protocol changes as a result.

It also introduces an experimental multiparty sender behind the hidden "_multiparty" feature gate.

Commit

e2a6f45

Changelog

• Make features additive Make _danger-local-https feature additive #430 Separate receive submodules to be additive #466 Organize feature separation for ergonomics #501 Clean up feature/module documentation with docs.rs features  #518
• Make receiver errors replyable to the sender Handle v2 error #474 Produce receive::JsonError accurately so that send can properly handle it #506 Only derive JsonError for errors that can return Json #526 Reply json #606
• Separate error modules Separate receive::{v1,v2} error modules #482
• Introduce "directory" feature module Introduce directory feature module #502
• Expose test helpers via payjoin-test-utils crate Expose test helpers #484
• Accomodate updated BIP78 spec Accomodate Updated BIP 78 Spec #505
• Fallback to first candidate if avoid_uih fails Fall back to first candidate if avoid_uih fails #533
• Use IntoUrl trait instead of Url in function signatures Use IntoUrl for more ergonomic function signatures #520
• Don't accept invalid certs even in tests don't accept invalid certs even in tests #550
• Introduce experimental multiparty sender behind the "_multiparty" feature flag Multiparty Senders: NS1R #434
• Add support for RFC 9540 RFC 9540 directory and receiver #549 Specify OHTTP gateway for opt-in respecting ohttp-relay #570 Update ohttp-relay to 0.0.10 #587
• Fix the pjos BIP21 parameter to match the BIP78 spec Correct the pjos parameter parity #546
• Introduce mutation testing Introduce cargo mutants cron job #573
• Add first-class persistence abstraction Persistable payjoin types #552
• Add many more tests, significantly improving test coverage

Checklist

Release numbering must follow Semantic Versioning. These steps assume the current master
branch development version is MAJOR.MINOR.0.

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-CRATE-MAJOR-MINOR+1, eg. bump-CRATE-0-22.
• Bump the bump-CRATE-MAJOR-MINOR+1 branch to the next development MINOR+1 version.
  • Change the Cargo.toml version value to MAJOR.MINOR+1.0.
  • Update the CHANGELOG.md file.
  • The commit message should be "Bump CRATE version to MAJOR.MINOR+1.0".
• Create PR for the bump-CRATE-MAJOR-MINOR+1 branch to master.
  • Title PR "Bump CRATE version to MAJOR.MINOR+1.0".
• Merge the bump-CRATE-MAJOR-MINOR+1 branch to master.

If any issues need to be fixed before the MAJOR.MINOR+1.0 version is released:

• Merge fix PRs to the master branch.
• Git cherry-pick fix commits to the bump-CRATE-MAJOR.MINOR+1 branch.
• Verify fixes in bump-CRATE-MAJOR.MINOR+1 branch.

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 CRATE-MAJOR.MINOR+1.0
  • The first line of the tag message should be "Release CRATE-MAJOR.MINOR+1.0".
  • 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.
• Build the docs locally to ensure they are building correctly.
• Push the new tag to the payjoin/rust-payjoin repo.
• Publish the crate in question 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 CRATE-MAJOR.MINOR+1.0.
  • 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, Nostr, and stacker.news.
• Celebrate 🎉

[DanGould]

"Build the docs locally to ensure they are building correctly." should probably come before tag pushing in the checklist

[spacebear21]

"Build the docs locally to ensure they are building correctly." should probably come before tag pushing in the checklist

It already does? https://github.com/payjoin/rust-payjoin/blob/master/.github/ISSUE_TEMPLATE/minor-release.md#on-the-day-of-the-release