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.

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

Adding apidiff target to the Makefile #3222

Conversation

meghanajangi
Copy link
Member

@meghanajangi meghanajangi commented Feb 16, 2022

Signed-off-by: Meghana Jangi mjangi@vmware.com

What type of PR is this?

What this PR does / why we need it:
Adds a Make target that takes a diff on API changes.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #3169

Special notes for your reviewer:

Checklist:

  • squashed commits
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

Release note:

Add apidiff Make target

@k8s-ci-robot k8s-ci-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Feb 16, 2022
@k8s-ci-robot
Copy link
Contributor

@meghanajangi: This issue is currently awaiting triage.

If CAPA/CAPI contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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
Copy link
Contributor

Hi @meghanajangi. 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 Feb 16, 2022
@Ankitasw
Copy link
Member

/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. release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 16, 2022
@sedefsavas sedefsavas added this to the v1.4.0 milestone Feb 16, 2022
@meghanajangi meghanajangi force-pushed the Adding-apidiff-target-to-the-Makefile branch from ed76cd8 to 628b69d Compare February 18, 2022 08:34
@meghanajangi meghanajangi force-pushed the Adding-apidiff-target-to-the-Makefile branch from 628b69d to feee74c Compare February 18, 2022 10:01
Makefile Outdated Show resolved Hide resolved
hack/tools/go.mod Outdated Show resolved Hide resolved
@meghanajangi meghanajangi force-pushed the Adding-apidiff-target-to-the-Makefile branch 2 times, most recently from e54d284 to 264b75b Compare February 18, 2022 12:04
@Ankitasw
Copy link
Member

@meghanajangi have you locally tested make apidiff. It gives error for me.

cd hack/tools && go build -tags=tools -o bin/go-apidiff github.com/joelanford/go-apidiff
go: downloading golang.org/x/exp v0.0.0-20211029160041-3396431c207b
hack/tools/bin/go-apidiff 33c9ef9 --print-compatible
git tree is dirty
make: *** [apidiff] Error 2

@meghanajangi meghanajangi force-pushed the Adding-apidiff-target-to-the-Makefile branch from 264b75b to c37830f Compare February 22, 2022 10:44
@meghanajangi
Copy link
Member Author

@meghanajangi have you locally tested make apidiff. It gives error for me.

cd hack/tools && go build -tags=tools -o bin/go-apidiff github.com/joelanford/go-apidiff
go: downloading golang.org/x/exp v0.0.0-20211029160041-3396431c207b
hack/tools/bin/go-apidiff 33c9ef9 --print-compatible
git tree is dirty
make: *** [apidiff] Error 2

I have fixed the git tree issue now, can you please check again?

@Ankitasw
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 22, 2022
Makefile Outdated Show resolved Hide resolved
@meghanajangi meghanajangi force-pushed the Adding-apidiff-target-to-the-Makefile branch from c37830f to c4fcc51 Compare February 23, 2022 10:25
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 23, 2022
@sedefsavas
Copy link
Contributor

I think we will need to update the apidiff script to use the new make target instead of calling apidiff binary directly.
https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/scripts/ci-apidiff.sh

After doing the changes, it will be great if you can confirm that the script is working and then we will merge the test-infra PR.

Signed-off-by: Meghana Jangi <mjangi@vmware.com>
@meghanajangi meghanajangi force-pushed the Adding-apidiff-target-to-the-Makefile branch from c4fcc51 to 111ee3b Compare February 24, 2022 07:06
@sedefsavas
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 2, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sedefsavas

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 Mar 2, 2022
@k8s-ci-robot k8s-ci-robot merged commit 54f8c19 into kubernetes-sigs:main Mar 2, 2022
@k8s-ci-robot k8s-ci-robot modified the milestones: v1.4.0, v1.x Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. needs-priority needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. 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 apidiff target to the Makefile
4 participants