ci: add kube-api-linter and fix doc and marker findings in api types#416
Open
Mesut Oezdil (mesutoezdil) wants to merge 1 commit into
Open
ci: add kube-api-linter and fix doc and marker findings in api types#416Mesut Oezdil (mesutoezdil) wants to merge 1 commit into
Mesut Oezdil (mesutoezdil) wants to merge 1 commit into
Conversation
748a99c to
4910796
Compare
|
And sorry if my comment sends you on a wild goose chase. I am not really involved in this project but I follow it for interest. cc Benjamin Elder (@BenTheElder) Tim Hockin (@thockin) I think having kube-api-linter is useful btu not sure what maintainers think. |
4910796 to
5126a9d
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Part of #207, following the plan discussed there with Julian Gutierrez Oschmann (@juli4n) and Kevin Hannon (@kannon92): plumbing plus the non invasive fixes first, with the existing invasive findings excluded so new APIs do not regress (as Kevin Hannon (@kannon92) suggested in #207 (comment)). The linter itself was originally suggested by Benjamin Elder (@BenTheElder) in #188.
Plumbing:
Fixes in pkg/api/v1alpha1 (doc and marker only, no Go API change):
Generated CRDs regenerated. Structural schema changes are only the conditions listType/listMapKey and sandboxClass no longer in the required list (it is defaulted, so behavior is the same); the rest is description text.
Note: my earlier count of 50 issues in #207 was capped by the default golangci-lint issue limit. With the cap removed the real total is 86; the extra ones are requiredfields (20) and ssatags (4), both in the excluded set above.
Test plan