Skip to content

ci: add cargo-public-api check for breaking API changes - #924

Merged
DaleSeo merged 2 commits into
mainfrom
chore/bump-rust-toolchain
Jun 24, 2026
Merged

ci: add cargo-public-api check for breaking API changes#924
DaleSeo merged 2 commits into
mainfrom
chore/bump-rust-toolchain

Conversation

@DaleSeo

@DaleSeoDaleSeo commented Jun 23, 2026

Copy link
Copy Markdown
Member

Adds a CI check using cargo-public-api to catch any source-breaking public API changes before the release. This is the safeguard suggested in #850 (comment).

@DaleSeo
DaleSeo requested a review from a team as a code ownerJune 23, 2026 22:51
@github-actionsgithub-actionsBot added the T-config Configuration file changes label Jun 23, 2026
Adds a release-type-aware `cargo-public-api` diff job that fails on
changed/removed public items unless the PR's commits mark a breaking
(major) release. This catches source-breaking API changes that
cargo-semver-checks cannot yet detect (e.g. function return-type or
field-type changes).
@github-actionsgithub-actionsBot added the T-CI Changes to CI/CD workflows and configuration label Jun 23, 2026
@DaleSeoDaleSeo changed the title chore: bump Rust toolchain to 1.96ci: add cargo-public-api check for breaking API changesJun 23, 2026
@DaleSeoDaleSeo self-assigned this Jun 23, 2026
@DaleSeoDaleSeo mentioned this pull request Jun 23, 2026

@joshuajbouwjoshuajbouw left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good to me! Nice addition. I'm surprised that cargo-semver-checks can't catch an issue like this yet.

@DaleSeo
DaleSeo merged commit 42a1069 into mainJun 24, 2026
19 checks passed
@DaleSeo
DaleSeo deleted the chore/bump-rust-toolchain branch June 24, 2026 19:19
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

T-CIChanges to CI/CD workflows and configurationT-configConfiguration file changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@DaleSeo@jamadeo@joshuajbouw