Skip to content
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

Jump to bottom

chore: Add apidiff target to Makefile #1525

Merged
merged 1 commit into from
May 9, 2022
Merged

chore: Add apidiff target to Makefile #1525

merged 1 commit into from
May 9, 2022

Conversation

ditsuke
Copy link
Contributor

@ditsuke ditsuke commented May 6, 2022 •
edited

What this PR does / why we need it:
We were lacking a target to generate apidiffs in our Makefile. Upstream, CAPI already had such a target referenced in the parent issue. This target will make it c convenient to check for and keep track of our public API changes.

Special notes for your reviewer:
apidiff might report git tree is dirty in Windows environments. I've reproduced this on CAPI, and its likely either an issue with my environment or an upstream issue in joelanford/go-apidiff. I've verified that this PR works in clean UNIX environments and will investigate the issue independent of this PR.

Which issue(s) this PR fixes
Fixes #1445

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 6, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @ditsuke. 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.

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/test-infra 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 6, 2022
@k8s-ci-robot k8s-ci-robot requested review from srm09 and vrabbi May 6, 2022 13:33
@ditsuke
chore: Add apidiff target to Makefile
675e083 
This commit adds an apidiff target to Makefile. Upstream,
CAPI already had this target. The target makes it convenient
to check our repo state for API changes and keep track of them.
chore: Add apidiff tooling binary to the tool module
@ditsuke
Copy link
Contributor Author

ditsuke commented May 6, 2022

Should we add an apidiff prow job in this PR or another once this is in?

/cc @geetikabatra @srm09

@k8s-ci-robot
Copy link
Contributor

@ditsuke: GitHub didn't allow me to request PR reviews from the following users: geetikabatra.

Note that only kubernetes-sigs members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Should we add an apidiff prow job in this PR or another once this is in?

/cc @geetikabatra @srm09

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/test-infra repository.

@srm09
Copy link
Contributor

srm09 commented May 6, 2022

This looks good, could you also raise a PR to add this as a non-required job in the CAPV presubmits file.
/lgtm
/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 6, 2022
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2022
@ditsuke
Copy link
Contributor Author

ditsuke commented May 7, 2022

This looks good, could you also raise a PR to add this as a non-required job in the CAPV presubmits file. /lgtm /ok-to-test

Sure! I'll raise it once this gets merged.

@srm09
Copy link
Contributor

srm09 commented May 9, 2022

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: srm09

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

The pull request process is described here

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 9, 2022
@k8s-ci-robot k8s-ci-robot merged commit ee4a286 into kubernetes-sigs:main May 9, 2022
This was referenced May 9, 2022
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@srm09 srm09 Awaiting requested review from srm09

@vrabbi vrabbi Awaiting requested review from vrabbi

Assignees

@srm09 srm09

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add apidiff target to the Makefile
3 participants
@ditsuke @k8s-ci-robot @srm09