ci: check semver compatibility - #147
Merged
Merged
Conversation
✅ Deploy Preview for dryoc-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
brndnmtthws
marked this pull request as ready for review
July 15, 2026 11:32
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #147 +/- ##
=======================================
Coverage 82.47% 82.47%
=======================================
Files 58 58
Lines 4427 4427
=======================================
Hits 3651 3651
Misses 776 776 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
Summary
Add
cargo-semver-checksto the normal build-and-test workflow so API compatibility is checked before release tags are created.User Impact
SemVer-incompatible public API changes will fail regular pull request CI according to the version already declared in
Cargo.toml, giving maintainers feedback before the tag-triggered publish workflow runs.Root Cause
The existing CI validates builds, tests, features, MSRV, documentation, and dependencies, but it does not compare the current public API with the latest published crate. The first release-specific validation currently happens after a tag is pushed.
Fix
Add a standalone
semver compatibilityjob that installscargo-semver-checkswith the stable Rust toolchain and runscargo semver-checks --verboseon pushes tomainand pull requests targetingmain.Validation
mise x actionlint@1.7.12 shellcheck@0.11.0 -- actionlint .github/workflows/build-and-test.ymlgit diff --check HEAD^cargo semver-checks --verboseagainst publisheddryoc0.9.0 and current 1.0.0