[WIP] 🌱 Enable optionalfields linter #12299
Conversation
k8s-ci-robot
added
do-not-merge/work-in-progress
|
This PR is currently missing an area label, which is used to identify the modified component when generating release notes. Area labels can be added by org members by writing Please see the labels list for possible areas. 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. |
k8s-ci-robot
added
the
size/S
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
| - module: 'sigs.k8s.io/kube-api-linter' | ||
| version: v0.0.0-20250515061849-37102c8f17a9 | ||
| - module: sigs.k8s.io/kube-api-linter | ||
| path: ../../../kube-api-linter |
There was a problem hiding this comment.
Requires to check out kubernetes-sigs/kube-api-linter#69 locally at this point
sbueringer
force-pushed
the
pr-optionalfields-linter
branch
from
1a28f2c to
1b12419
Compare
| @@ -44,6 +46,12 @@ linters: | |||
| # optionalOrRequired: | |||
| # preferredOptionalMarker: optional | kubebuilder:validation:Optional # The preferred optional marker to use, fixes will suggest to use this marker. Defaults to `optional`. | |||
| # preferredRequiredMarker: required | kubebuilder:validation:Required # The preferred required marker to use, fixes will suggest to use this marker. Defaults to `required`. | |||
| optionalFields: | |||
| pointers: | |||
| preference: Always # Always | WhenRequired # Whether to always require pointers, or only when required. Defaults to `Always`. | |||
There was a problem hiding this comment.
IMO, this should be WhenRequired, but it will mean more work now.
When set to WhenRequired, we will be required to set a minimum length, and min/max values on all string and numeric values respectively.
The linter will then determine whether or not the zero value of the field is valid. If the zero value is not valid, then the optional field does not need to be a pointer, so we can remove it and make the code simpler.
Where the zero value is valid (eg replicas fields, set minimum to 0), then it will report that the field needs to be a pointer still
What this PR does / why we need it:
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 #