CI: add a Roave backwards-compatibility check on pull requests - #23
Merged
Conversation
Mirrors Setono/SyliusPluginSkeleton's workflow: compares the PR against its base branch with roave/backward-compatibility-check and fails on BC breaks. Runs on PHP 8.4 because the current tool releases require >= 8.4 (it analyses our >= 8.1 sources fine); the checkout uses fetch-depth 0 so the base ref is available. CLAUDE.md documents the gate.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 1.x #23 +/- ##
=========================================
Coverage 99.02% 99.02%
Complexity 190 190
=========================================
Files 26 26
Lines 511 511
=========================================
Hits 506 506
Misses 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
15 tasks
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
1 participant
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
.github/workflows/backwards-compatibility-check.yaml, mirroring Setono/SyliusPluginSkeleton's: on every pull request,roave/backward-compatibility-check --from=origin/<base>compares the PR's public API against its base branch and fails on breaking changes.Two deliberate deviations from the skeleton:
>= 8.1sources fine.actions/checkout@v6, matchingbuild.yaml.CLAUDE.md documents the gate. The check runs on this PR itself (
pull_requestworkflows are taken from the merge ref); the currently open #16/#17/#19/#20 will only get it on their next push — they're additive anyway, and #14/#18 (already merged) carried the small, documented interface changes.