ci: fail closed on API compatibility checks - #837
Open
ryanduguid wants to merge 5 commits into
Open
Conversation
ryanduguid
marked this pull request as ready for review
August 18, 2026 15:08
Enumerate the union of specs in the base ref and the working tree, and treat
a spec present in the base but absent at head as a breaking change. The list
was built only from `ls xero*.yaml` in the working tree, so a spec deleted or
renamed in a PR was never compared: deleting xero_bankfeeds.yaml reported
"No breaking changes detected across all files" and exited 0. That block was
byte-identical to master, so the fail-closed change did not cover it.
Strip only the remote prefix when deriving the ref to fetch. `${BASE_BRANCH##*/}`
kept just the last path segment, so a PR based on feature/prism-changes fetched
"prism-changes", which does not exist, and `set -e` aborted with exit 128 before
any spec was compared.
Correct the actions/checkout version comment to v4.4.0. The pinned SHA
11d5960a326750d5838078e36cf38b85af677262 is v4.4.0, not v4.2.2, which is
11bd71901bbe5b1630ceea73d27597364c9af683. The SHA is kept because it is
immutable and current; only the comment was wrong.
Update the README to match the enforced behaviour: drop the removed
--fail-on-breaking flag and the conventional-commit waiver, drop the deleted
test-conventional-commit-logic job, and document the real fail-closed rules
and exit codes.
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.
Summary
Validation
bash -n scripts/api-diff/api-diff.sh scripts/api-diff/api-diff.test.shbash scripts/api-diff/api-diff.test.shactionlint .github/workflows/api-diff.ymlgit diff --checkPin provenance was checked against the upstream oasdiff v1.28.0 release and the publisher's Docker registry manifest. The
tufin/oasdiff:v1.28.0multi-platform manifest resolved tosha256:86830f988eaafcf589acb2794ee5ab78e3300ded071d6517bf085469300cbf36, matching the workflow default.Docker is unavailable in the local Windows environment, so the local test suite uses a deterministic fake Docker command to exercise each exit path. Trusted Codegen Repo Validation passed on exact head
3311e7bin 4m32s (run 31624823983).