Skip to content

ci: allow overriding APIDiff with apidiff-override label #5690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
isumitsolanki wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −0
Open

ci: allow overriding APIDiff with apidiff-override label #5690

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/apidiff.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ jobs:
go-apidiff:
permissions:
contents: read
pull-requests: read
name: Verify API differences
runs-on: ubuntu-latest
# Pull requests from different repository only trigger this checks
Expand All @@ -28,8 +29,27 @@ jobs:
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
with:
go-version-file: go.mod
# When go-apidiff fails, maintainers may add label apidiff-override to accept intentional API changes (fork PRs use GitHub Actions; same-repo PRs use Prow).
Copy link
Copy Markdown
Member

@camilamacedo86 camilamacedo86 May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The check here is not go-apidfiff
We must ajust it for our check
Could you please check it out?

- name: Execute go-apidiff
id: go-apidiff
Copy link
Copy Markdown
Member

@camilamacedo86 camilamacedo86 May 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

continue-on-error: true
uses: joelanford/go-apidiff@60c4206be8f84348ebda2a3e0c3ac9cb54b8f685 # v0.8.3
with:
compare-imports: true
print-compatible: true
- name: Require clean API diff or override label
if: ${{ steps.go-apidiff.outcome == 'failure' }}
env:
GH_TOKEN: ${{ github.token }}
OWNER: ${{ github.repository_owner }}
REPO: ${{ github.event.repository.name }}
PR: ${{ github.event.pull_request.number }}
OVERRIDE_LABEL: apidiff-override
run: |
set -euo pipefail
if gh api "repos/${OWNER}/${REPO}/pulls/${PR}" --jq '.labels[].name' | grep -qxF "${OVERRIDE_LABEL}"; then
echo "Found label '${OVERRIDE_LABEL}'; accepting failed API diff check."
exit 0
fi
echo "::error::API diff reported incompatible changes and PR does not have label '${OVERRIDE_LABEL}'. Maintainers may add that label if the change is intentional."
exit 1