Add optional go-apidiff test to CI #98
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Joe Lanford <joe.lanford@gmail.com>
joelanford
force-pushed
the
go-apidiff
branch
from
821f87f to
191629d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wrote
go-apidiffto help maintainers ofkubernetes-sigs/controller-runtimeeasily identify PRs that break Go APIs. It's also being used inkubernetes-sigs/cluster-api*repos.Today I finally got around to making a GitHub action out of it. I figured it might help in some of the operator-framework repos that are used as libraries.
It will compare the PR head with the target branch, report any API changes, and fail if any of them are breaking changes. Other projects using this make this test optional so that it is a simple signal to maintainers about whether changes are API-compatible.