ci: add apidiff workflow to detect breaking changes#362
Open
aojea wants to merge 1 commit into
Open
Conversation
Adds a GitHub Actions job to compare the module API of a PR branch against the target branch. The job uses `apidiff` in module mode to detect incompatible changes or removed packages. Intentional breaking changes can be allowed by adding the 'breaking change allowed' label to the PR.
Contributor
Author
|
/assign @stapelberg |
aojea
commented
Jul 22, 2026
| apidiff: | ||
| runs-on: ubuntu-latest | ||
| # Run only on pull requests, and skip if the PR has the 'breaking change allowed' label. | ||
| if: ${{ github.base_ref && !contains(github.event.pull_request.labels.*.name, 'breaking change allowed') }} |
Contributor
Author
There was a problem hiding this comment.
the label needs to be created to avoid having to override the job
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 a GitHub Actions job to compare the module API of a PR branch against the target branch. The job uses
apidiffin module mode to detect incompatible changes or removed packages. Intentional breaking changes can be allowed by adding the 'breaking change allowed' label to the PR (this label needs to be created)