Repository navigation
Add verify-crdify script to detect breaking changes in CRDs - #4830
Conversation
|
Welcome @ElenaZvereva! |
|
Hi @ElenaZvereva. 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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
/kind cleanup |
|
@ElenaZvereva: The label(s) DetailsIn response to this:
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. |
|
Hi @rikatz! Could you please run waiting workflows? My plan is:
So I’ll need help triggering jobs twice: once now and once after introducing breaking changes. I also have two questions:
|
|
hi @ElenaZvereva thanks for your contribution! I've left some comments here to be verified. Also I guess i have answered both of your quiestions:
Thanks!! |
Co-authored-by: Ricardo Pchevuzinske Katz <7182341+rikatz@users.noreply.github.com>
|
/test pull-gateway-api-verify |
|
/label tide/merge-method-squash |
|
@ElenaZvereva thanks. But why are there changes on the stable API? Can we revert it? Thanks! |
|
@rikatz Hi! Yes, of course, I’ll revert it. I added these changes only to test how the script behaves with breaking CRD changes in Prow. One thing I noticed is that because CRDIFY_ENFORCE is currently set to false by default, the job still reports success even when breaking changes are detected. As a result, the overall output shows Do you think this behavior is good enough for now, or should we make the warning more visible while keeping the job non-blocking? |
|
hum is there a way we can make the warning more visible on prow without blocking the job? 🤔 if so it would be great, otherwise we can probably enable it by default (or add a github action just for this job that can fail but is not required), wdyt? |
|
Yes, I think we have a few options to make the warning more visible (although it still stays only in prow):
But I think enabling CRDIFY_ENFORCE by default is a good option. To be honest, I’m not sure I fully understand the concern around BackendTLSPolicy. Do we expect some necessary changes to this CRD in the near future that would be considered breaking changes by crdify? In other words, why do we need the CRDIFY_ENFORCE flag in the first place? |
|
the flag is more like a guardrail/breaking glass button IMO. Let's enable it by default, if we feel this will break releases or slow us down I can work on disabling it and merging quickly. Once more, appreciate the effort! |
|
Ok, sounds good. I’ve enabled the flag by default |
|
For now this is all, thank you very much @ElenaZvereva ! |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ElenaZvereva, rikatz The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/release-note-none |
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
This PR adds a new verify script
hack/verify-crdify.sh, which checks for backward-incompatible changes in CRDs using crdify.The script compares CRDs in the current branch against a base reference and runs crdify validations for each CRD file under
config/crd/standardWhich issue(s) this PR fixes:
Part of #4723
Does this PR introduce a user-facing change?:
NONE