Skip to content

Add automated public API backward compatibility checks - #36

Merged
erseco merged 4 commits into
security/release-supply-chainfrom
quality/backward-compatibility
Sep 19, 2026
Merged

erseco merged 4 commits into
security/release-supply-chainfrom
quality/backward-compatibility

Conversation

@erseco

@erseco erseco commented Sep 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add Roave Backward Compatibility Check to pull-request CI
  • compare the public Composer-autoloaded API from origin/main to the PR HEAD
  • pin Roave BC Check to version 8.22.0
  • run the tool in a dedicated PHP 8.4 job so it does not change the package's PHP 8.0 runtime requirements
  • use GitHub Actions annotation output for incompatible changes
  • fetch complete git history so revision comparison is reliable
  • document the Semantic Versioning/BC policy and intentional-major-release process
  • update contributing guidance

Stack

This PR is stacked on #35 and targets security/release-supply-chain.

Behavior

Pull requests that modify src/**, composer.json or the BC workflow fail when they introduce an unapproved public API break relative to main.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.4%. Comparing base (e3554df) to head (a7d8e5b).

Additional details and impacted files

Impacted file tree graph

@@                       Coverage Diff                       @@
##             security/release-supply-chain     #36   +/-   ##
===============================================================
  Coverage                             92.4%   92.4%           
  Complexity                             801     801           
===============================================================
  Files                                   30      30           
  Lines                                 2639    2639           
===============================================================
  Hits                                  2441    2441           
  Misses                                 198     198           
Flag Coverage Δ
unit 92.4% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@erseco
erseco added this pull request to stack #38 September 19, 2026 21:24
@erseco
erseco merged commit d223f39 into main Sep 19, 2026
28 checks passed
@erseco
erseco deleted the quality/backward-compatibility branch September 19, 2026 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants