-
Notifications
You must be signed in to change notification settings - Fork 71
🌱 Replace deprecated marker for required fields #2407
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
base: main
Are you sure you want to change the base?
🌱 Replace deprecated marker for required fields #2407
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR modernizes the API type definitions by replacing the deprecated +kubebuilder:validation:Required marker with the newer +required marker across all API types. The change is purely a marker update with no functional impact on the generated CRDs.
- Replaces
+kubebuilder:validation:Requiredwith+requiredin all API type definitions - Updates auto-generated API reference documentation to reflect the new marker format
- Applies the change consistently across ClusterExtension, ClusterExtensionRevision, and ClusterCatalog types
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
hack/tools/crd-generator/testdata/api/v1/clusterextension_types.go |
Updates test data for CRD generator with new required field marker |
api/v1/clusterextension_types.go |
Replaces deprecated required marker in ClusterExtension type definitions |
api/v1/clusterextensionrevision_types.go |
Replaces deprecated required marker in ClusterExtensionRevision type definitions |
api/v1/clustercatalog_types.go |
Replaces deprecated required marker in ClusterCatalog type definitions |
docs/api-reference/olmv1-api-reference.md |
Updates auto-generated API documentation to reflect new marker format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2407 +/- ##
==========================================
- Coverage 69.55% 69.53% -0.03%
==========================================
Files 102 102
Lines 8354 8354
==========================================
- Hits 5811 5809 -2
- Misses 2079 2080 +1
- Partials 464 465 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
When we have a new release with elastic/crd-ref-docs#192 we can check this one again. |
fe4bc7e to
8f5cdde
Compare
8f5cdde to
d678562
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
/hold cancel |
|
The linter check mark as solved the usage of the deprecated markers So, we must override /override api-diff-lint /override lint-api-diff |
|
@camilamacedo86: /override requires failed status contexts, check run or a prowjob name to operate on.
Only the following failed contexts/checkruns were expected:
If you are trying to override a checkrun that has a space in it, you must put a double quote on the context. 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. |
|
/override api-diff-lint-override |
|
@camilamacedo86: /override requires failed status contexts, check run or a prowjob name to operate on.
Only the following failed contexts/checkruns were expected:
If you are trying to override a checkrun that has a space in it, you must put a double quote on the context. 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. |
The redundante marker should no longer be used.
More info: kubernetes-sigs/controller-tools#1241
Motivation
kube-api-linter only recognize // +required and not the kubebuilder marker