kubernetes-sigs / kubernetes-sigs/cluster-api
API Linting Tracking Issue
- Dominant language
- Go
- Stars
- 4.3k
- Forks
- 1.6k
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 113
Description
As part of #11733, we have configured KAL, that kube-api-linter to run against the APIs within this repository.
There are a number of linter rules that need to be reviewed and enabled 1 by 1.
This issue is to track the implementation of enabling each of these linters
---
### TODO
- [x] conditions - #11847
- [x] commentstart -
- [x] #11870
- Related: https://github.com/kubernetes-sigs/cluster-api/issues/11238
- [x] integers - #11887
- [x] jsontags - #11890
- [x] maxlength -
- [x] Enable the linter #11906
- [x] Enable MaxItems https://github.com/kubernetes-sigs/cluster-api/pull/11934
- [x] Enable MaxLength https://github.com/kubernetes-sigs/cluster-api/pull/11949
- [x] nobools - #11911
- [x] nofloats - #11910
- [ ] optionalorrequired
- [x] Enable the linter #11909
- [ ] Follow-up for Items fields (exclude "field Items must be marked as optional or required")
- [x] requiredfields - #11908
- [x] statussubresource - #11907
---
### Not doing
#### NoPhase
Per discussion in July 2024, we are keeping phase fields for now.
See https://github.com/kubernetes-sigs/cluster-api/pull/10897#discussion_r1685929508 and https://github.com/kubernetes-sigs/cluster-api/pull/10897#discussion_r1685919394 for the context on why we are still keeping phases.
Contributor guide
Assessment
This issue has not been assessed yet.