ci: add cargo-public-api check for breaking API changes#924
Open
DaleSeo wants to merge 2 commits into
Open
Conversation
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).
DaleSeo
changed the title
Merged
joshuajbouw
approved these changes
Jun 23, 2026
joshuajbouw
left a comment
joshuajbouw
left a comment
There was a problem hiding this comment.
Looks good to me! Nice addition. I'm surprised that cargo-semver-checks can't catch an issue like this yet.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a CI check using
cargo-public-apito catch any source-breaking public API changes before the release. This is the safeguard suggested in #850 (comment).