-
Notifications
You must be signed in to change notification settings - Fork 262
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
CI: check apidiff once v1beta1 is released #1860
Comments
This is a great idea in principal. I'm not convinced this specific library will help us, though, as it seems to be checking Go semantics rather than K8S semantics, and could therefore give us both false-positives (e.g. altering a Go field in a manner which doesn't affect the CRD) and false-negatives (e.g. altering a kubebuilder marker in a comment which is not visible in the Go semantics, but does alter the CRD). That said, in light of #1891 we may want to start caring about the former, which we have not done previously. |
Azure has it: And the way they use it is pretty smart:
So I really propose that we find a way to have something similar. |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues. This bot triages un-triaged issues according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
/remove-lifecycle stale This one is close to my heart, I'll take care of it. |
I think we should care about the Go API also, so this would be useful. |
It would be good to agree the scope of our Go stability guarantees. We should probably also switch to proper semver for CAPO releases to account for breaking changes. |
/kind feature
Describe the solution you'd like
Once we release CAPO v1beta1, our API should remain stable.
One way to check that in CI is to use github.com/joelanford/go-apidiff as it's already done in other providers.
We could add a job that will run apidiff against PR and return an error if the API change is major and not minor.
The text was updated successfully, but these errors were encountered: