Skip to content

ci: add apidiff workflow to detect breaking changes #362

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
aojea wants to merge 1 commit into
base: main
Choose a base branch
from
+39 −0
Open

ci: add apidiff workflow to detect breaking changes #362

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
39 changes: 39 additions & 0 deletions .github/workflows/push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,42 @@ jobs:
sudo ./nftables.test -test.v -run_system_tests
go test -c github.com/google/nftables/integration
(cd integration && sudo ../integration.test -test.v -run_system_tests)

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') }}

@aojea aojea Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

the label needs to be created to avoid having to override the job

steps:
- name: Install Go
uses: actions/setup-go@v4
with:
go-version: ^1.20
- name: Add GOBIN to PATH
run: echo "$(go env GOPATH)/bin" >> $GITHUB_PATH
- name: Install dependencies
run: go install golang.org/x/exp/cmd/apidiff@7ab1446f8b90c13150a856cfe6a0e8ab9af5a50d
# We checkout both the base branch (old) and the PR branch (new) to compare them.
- name: Checkout old code (base ref)
uses: actions/checkout@v3
with:
ref: ${{ github.base_ref }}
path: "old"
- name: Checkout new code (PR head)
uses: actions/checkout@v3
with:
path: "new"
- name: APIDiff
run: |
# Generate baseline from old code (module level)
cd old
apidiff -m -w ../module.baseline .

# Compare with new code (module level), writing incompatible changes to diff.txt
cd ../new
apidiff -m -incompatible ../module.baseline . > ../diff.txt
cd ..

# Print the diff to the build log
cat diff.txt
# Fail the job if diff.txt is not empty (contains incompatible changes)
! [ -s diff.txt ]
Loading