Skip to content

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

Open
isumitsolanki wants to merge 1 commit into
kubernetes-sigs:masterfrom
isumitsolanki:issue_5655
Open

ci: allow overriding APIDiff with apidiff-override label#5690
isumitsolanki wants to merge 1 commit into
kubernetes-sigs:masterfrom
isumitsolanki:issue_5655

Conversation

@isumitsolanki
Copy link
Copy Markdown

Description

The fork-only APIDiff workflow (.github/workflows/apidiff.yml) still runs joelanford/go-apidiff as before, but the step now uses continue-on-error with id go-apidiff. A new step Require clean API diff or override label runs when that step fails: it uses the GitHub CLI and GITHUB_TOKEN to list the PR’s labels and passes the job only if the label apidiff-override is present; otherwise it fails with a clear error message. The job gains pull-requests: read so token permissions are sufficient to read labels.

Motivation

For pull requests from forks, API compatibility is enforced by GitHub Actions, while Prow handles checks for PRs from the main repo. That split meant there was no supported maintainer escape hatch when go-apidiff failed but an incompatible API change was intentional and already reviewed. Adding a label-based override matches the pattern used in other projects (e.g. API diff jobs that allow a dedicated override label) and keeps the default behavior strict unless a maintainer explicitly approves the exception.

Issue

Fixes #5655

Signed-off-by: Sumit Solanki <sumit.solanki@ibm.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 10, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: isumitsolanki
Once this PR has been reviewed and has the lgtm label, please assign varshaprasad96 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @isumitsolanki!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @isumitsolanki. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 10, 2026
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

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?

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).
- name: Execute go-apidiff
id: go-apidiff
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add option to override GtiHub CI checks

3 participants