Integrate with github.com/kubernetes-sigs/kube-api-linter

[juli4n]

This is a follow up of #188 (review) where Benjamin Elder (@BenTheElder) suggested integrating with the kube-api-linter to lint our k8s types.

[mesutoezdil]

ran kube-api-linter against pkg/api/v1alpha1/ (3 files: actortemplate_types.go, workerpool_types.go, sandboxconfig_types.go). and found 50 issues across these categories:

(rule // count // impact)

commentstart // 38 // doc-only, no api change
optionalfields // 6 // api change: string/bool fields become pointers, callers need updates
defaults // 2 // annotation-only, no api change
nophase // 1 // api change: phase field rename, needs discussion
nomaps // 1 // api change: map[string]map[string]assetfile -> list type, significant refactor
defaultorrequired // 1 // annotation-only
conditions // 1 // annotation-only

proposed approach from me:

// pr1: commentstart + defaults + defaultorrequired + conditions fixes (doc/annotation only, no api change)

// pr2: optionalfields, nophase, nomaps; these touch the api surface and likely need separate discussion before implementation

happy to proceed with pr 1 if this looks right.

does the team want to tackle the api-breaking rules separately or skip some of them (e.g. nomaps is a significant refactor)?

[kannon92]

As someone who has added kube-api-linter to existing projects, I recommend getting the plumbing (CI and all) and fix the non invasive problems first.

Its worth excluding the existing failures (pr2) so that new APis don't regress.

[mesutoezdil]

PR is up: #416

It follows the split above plus Kevin Hannon (@kannon92)'s suggestion: CI plumbing, the non invasive fixes (commentstart, conditions, defaultorrequired, optionalorrequired), and the invasive rules (nomaps, nonpointerstructs, nophase, optionalfields, requiredfields, ssatags) excluded in the config so new APIs do not regress. Fixing those on the existing types would be the follow up here.

One correction to my earlier count: the 50 was capped by the default golangci-lint issue limit, the real total is 86. The hidden ones are requiredfields (20) and ssatags (4), both in the excluded set.