✨ (go/v4): scaffold kube-api-linter support in new projects

docs/book/src/cronjob-tutorial/testdata/project/.custom-gcl.yml

@@ -0,0 +1,7 @@
+version: v2.5.0
+name: golangci-lint-kube-api
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest

docs/book/src/cronjob-tutorial/testdata/project/.github/workflows/lint.yml

@@ -17,7 +17,13 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - name: Check linter configuration
+        run: make lint-config
+
       - name: Run linter
         uses: golangci/golangci-lint-action@v8
         with:
           version: v2.5.0
+
+      - name: Run lint target
+        run: make lint

docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml

@@ -21,11 +21,23 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: module
+        description: "Kube API Linter plugin"
+        original-url: "sigs.k8s.io/kube-api-linter"
+        settings:
+          linters: {}
+          lintersConfig:
+            optionalfields:
+              pointers:
+                preference: WhenRequired
   exclusions:
     generated: lax
     rules:
@@ -36,6 +48,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$

docs/book/src/cronjob-tutorial/testdata/project/Makefile

@@ -188,7 +188,8 @@ KIND ?= kind
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
-GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
+GOLANGCI_LINT_BASE = $(LOCALBIN)/golangci-lint
+GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-kube-api
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.7.1
@@ -230,8 +231,17 @@ $(ENVTEST): $(LOCALBIN)
 
 .PHONY: golangci-lint
 golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
-$(GOLANGCI_LINT): $(LOCALBIN)
-	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+$(GOLANGCI_LINT_BASE): $(LOCALBIN)
+	$(call go-install-tool,$(GOLANGCI_LINT_BASE),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+$(GOLANGCI_LINT): $(GOLANGCI_LINT_BASE) .custom-gcl.yml
+	@echo "Running golangci-lint custom..."
+	@$(GOLANGCI_LINT_BASE) custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(GOLANGCI_LINT_BASE); \
+		exit 1; \
+	}
 
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary

docs/book/src/cronjob-tutorial/testdata/project/api/v1/cronjob_types.go

@@ -67,7 +67,7 @@
 	// schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
 	// +kubebuilder:validation:MinLength=0
 	// +required
 	Schedule string `json:"schedule"`
 
 	// startingDeadlineSeconds defines in seconds for starting the job if it misses scheduled
 	// time for any reason.  Missed jobs executions will be counted as failed ones.
@@ -91,7 +91,7 @@
 
 	// jobTemplate defines the job that will be created when executing a CronJob.
 	// +required
 	JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
 
 	// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
 	// This is a pointer to distinguish between explicit zero and not specified.
@@ -172,7 +172,7 @@
 	// +listType=map
 	// +listMapKey=type
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 /*
@@ -192,23 +192,23 @@
 
 	// metadata is a standard object metadata
 	// +optional
-	metav1.ObjectMeta `json:"metadata,omitempty,omitzero"`
+	metav1.ObjectMeta `json:"metadata,omitzero"`
 
 	// spec defines the desired state of CronJob
 	// +required
 	Spec CronJobSpec `json:"spec"`
 
 	// status defines the observed state of CronJob
 	// +optional
-	Status CronJobStatus `json:"status,omitempty,omitzero"`
+	Status CronJobStatus `json:"status,omitzero"`
 }
 
 // +kubebuilder:object:root=true
 
 // CronJobList contains a list of CronJob
 type CronJobList struct {
 	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata,omitempty"`
+	metav1.ListMeta `json:"metadata,omitzero"`
 	Items           []CronJob `json:"items"`
 }
 

docs/book/src/getting-started/testdata/project/.custom-gcl.yml

@@ -0,0 +1,7 @@
+version: v2.5.0
+name: golangci-lint-kube-api
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest

docs/book/src/getting-started/testdata/project/.github/workflows/lint.yml

@@ -17,7 +17,13 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - name: Check linter configuration
+        run: make lint-config
+
       - name: Run linter
         uses: golangci/golangci-lint-action@v8
         with:
           version: v2.5.0
+
+      - name: Run lint target
+        run: make lint

docs/book/src/getting-started/testdata/project/.golangci.yml

@@ -21,11 +21,23 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: module
+        description: "Kube API Linter plugin"
+        original-url: "sigs.k8s.io/kube-api-linter"
+        settings:
+          linters: {}
+          lintersConfig:
+            optionalfields:
+              pointers:
+                preference: WhenRequired
   exclusions:
     generated: lax
     rules:
@@ -36,6 +48,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$

docs/book/src/getting-started/testdata/project/Makefile

@@ -184,7 +184,8 @@ KIND ?= kind
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
-GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
+GOLANGCI_LINT_BASE = $(LOCALBIN)/golangci-lint
+GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-kube-api
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.7.1
@@ -226,8 +227,17 @@ $(ENVTEST): $(LOCALBIN)
 
 .PHONY: golangci-lint
 golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
-$(GOLANGCI_LINT): $(LOCALBIN)
-	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+$(GOLANGCI_LINT_BASE): $(LOCALBIN)
+	$(call go-install-tool,$(GOLANGCI_LINT_BASE),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+$(GOLANGCI_LINT): $(GOLANGCI_LINT_BASE) .custom-gcl.yml
+	@echo "Running golangci-lint custom..."
+	@$(GOLANGCI_LINT_BASE) custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(GOLANGCI_LINT_BASE); \
+		exit 1; \
+	}
 
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary

docs/book/src/getting-started/testdata/project/api/v1alpha1/memcached_types.go

@@ -40,7 +40,7 @@
 	// +kubebuilder:validation:Maximum=3
 	// +kubebuilder:validation:ExclusiveMaximum=false
 	// +optional
 	Size *int32 `json:"size,omitempty"`
 }
 
 // MemcachedStatus defines the observed state of Memcached.
@@ -63,7 +63,7 @@
 	// +listType=map
 	// +listMapKey=type
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -75,23 +75,23 @@
 
 	// metadata is a standard object metadata
 	// +optional
-	metav1.ObjectMeta `json:"metadata,omitempty,omitzero"`
+	metav1.ObjectMeta `json:"metadata,omitzero"`
 
 	// spec defines the desired state of Memcached
 	// +required
 	Spec MemcachedSpec `json:"spec"`
 
 	// status defines the observed state of Memcached
 	// +optional
-	Status MemcachedStatus `json:"status,omitempty,omitzero"`
+	Status MemcachedStatus `json:"status,omitzero"`
 }
 
 // +kubebuilder:object:root=true
 
 // MemcachedList contains a list of Memcached
 type MemcachedList struct {
 	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata,omitempty"`
+	metav1.ListMeta `json:"metadata,omitzero"`
 	Items           []Memcached `json:"items"`
 }
 

docs/book/src/multiversion-tutorial/testdata/project/.custom-gcl.yml

@@ -0,0 +1,7 @@
+version: v2.5.0
+name: golangci-lint-kube-api
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest

docs/book/src/multiversion-tutorial/testdata/project/.github/workflows/lint.yml

@@ -17,7 +17,13 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - name: Check linter configuration
+        run: make lint-config
+
       - name: Run linter
         uses: golangci/golangci-lint-action@v8
         with:
           version: v2.5.0
+
+      - name: Run lint target
+        run: make lint

docs/book/src/multiversion-tutorial/testdata/project/.golangci.yml

@@ -21,11 +21,23 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: module
+        description: "Kube API Linter plugin"
+        original-url: "sigs.k8s.io/kube-api-linter"
+        settings:
+          linters: {}
+          lintersConfig:
+            optionalfields:
+              pointers:
+                preference: WhenRequired
   exclusions:
     generated: lax
     rules:
@@ -36,6 +48,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$

docs/book/src/multiversion-tutorial/testdata/project/Makefile

@@ -188,7 +188,8 @@ KIND ?= kind
 KUSTOMIZE ?= $(LOCALBIN)/kustomize
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 ENVTEST ?= $(LOCALBIN)/setup-envtest
-GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
+GOLANGCI_LINT_BASE = $(LOCALBIN)/golangci-lint
+GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-kube-api
 
 ## Tool Versions
 KUSTOMIZE_VERSION ?= v5.7.1
@@ -230,8 +231,17 @@ $(ENVTEST): $(LOCALBIN)
 
 .PHONY: golangci-lint
 golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
-$(GOLANGCI_LINT): $(LOCALBIN)
-	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+$(GOLANGCI_LINT_BASE): $(LOCALBIN)
+	$(call go-install-tool,$(GOLANGCI_LINT_BASE),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
+
+$(GOLANGCI_LINT): $(GOLANGCI_LINT_BASE) .custom-gcl.yml
+	@echo "Running golangci-lint custom..."
+	@$(GOLANGCI_LINT_BASE) custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(GOLANGCI_LINT_BASE); \
+		exit 1; \
+	}
 
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary

docs/book/src/multiversion-tutorial/testdata/project/api/v1/cronjob_types.go

@@ -39,7 +39,7 @@
 	// schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
 	// +kubebuilder:validation:MinLength=0
 	// +required
 	Schedule string `json:"schedule"`
 
 	// startingDeadlineSeconds defines in seconds for starting the job if it misses scheduled
 	// time for any reason.  Missed jobs executions will be counted as failed ones.
@@ -63,7 +63,7 @@
 
 	// jobTemplate defines the job that will be created when executing a CronJob.
 	// +required
 	JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
 
 	// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
 	// This is a pointer to distinguish between explicit zero and not specified.
@@ -128,7 +128,7 @@
 	// +listType=map
 	// +listMapKey=type
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:docs-gen:collapse=Remaining code from cronjob_types.go
@@ -151,20 +151,20 @@
 // +versionName=v1
 // +kubebuilder:storageversion
 // CronJob is the Schema for the cronjobs API
 type CronJob struct {
 	metav1.TypeMeta `json:",inline"`
 
 	// metadata is a standard object metadata
 	// +optional
-	metav1.ObjectMeta `json:"metadata,omitempty,omitzero"`
+	metav1.ObjectMeta `json:"metadata,omitzero"`
 
 	// spec defines the desired state of CronJob
 	// +required
 	Spec CronJobSpec `json:"spec"`
 
 	// status defines the observed state of CronJob
 	// +optional
-	Status CronJobStatus `json:"status,omitempty,omitzero"`
+	Status CronJobStatus `json:"status,omitzero"`
 }
 
 /*
@@ -175,7 +175,7 @@
 // CronJobList contains a list of CronJob
 type CronJobList struct {
 	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata,omitempty"`
+	metav1.ListMeta `json:"metadata,omitzero"`
 	Items           []CronJob `json:"items"`
 }
 

docs/book/src/multiversion-tutorial/testdata/project/api/v2/cronjob_types.go

@@ -43,7 +43,7 @@
 type CronJobSpec struct {
 	// schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
 	// +required
 	Schedule CronSchedule `json:"schedule"`
 
 	/*
 	 */
@@ -70,7 +70,7 @@
 
 	// jobTemplate defines the job that will be created when executing a CronJob.
 	// +required
 	JobTemplate batchv1.JobTemplateSpec `json:"jobTemplate"`
 
 	// successfulJobsHistoryLimit defines the number of successful finished jobs to retain.
 	// This is a pointer to distinguish between explicit zero and not specified.
@@ -146,7 +146,7 @@
 
 // CronJobStatus defines the observed state of CronJob.
 type CronJobStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 	// active defines a list of pointers to currently running jobs.
 	// +optional
@@ -174,7 +174,7 @@
 	// +listType=map
 	// +listMapKey=type
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
@@ -186,23 +186,23 @@
 
 	// metadata is a standard object metadata
 	// +optional
-	metav1.ObjectMeta `json:"metadata,omitempty,omitzero"`
+	metav1.ObjectMeta `json:"metadata,omitzero"`
 
 	// spec defines the desired state of CronJob
 	// +required
 	Spec CronJobSpec `json:"spec"`
 
 	// status defines the observed state of CronJob
 	// +optional
-	Status CronJobStatus `json:"status,omitempty,omitzero"`
+	Status CronJobStatus `json:"status,omitzero"`
 }
 
 // +kubebuilder:object:root=true
 
 // CronJobList contains a list of CronJob
 type CronJobList struct {
 	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata,omitempty"`
+	metav1.ListMeta `json:"metadata,omitzero"`
 	Items           []CronJob `json:"items"`
 }
 

pkg/plugins/golang/deploy-image/v1alpha1/scaffolds/internal/templates/api/types.go

@@ -126,23 +126,23 @@ type {{ .Resource.Kind }} struct {
 
 	// metadata is a standard object metadata
 	// +optional
-	metav1.ObjectMeta ` + "`" + `json:"metadata,omitempty,omitzero"` + "`" + `
+	metav1.ObjectMeta ` + "`" + `json:"metadata,omitzero"` + "`" + `
 
 	// spec defines the desired state of {{ .Resource.Kind }}
 	// +required
 	Spec   {{ .Resource.Kind }}Spec   ` + "`" + `json:"spec"` + "`" + `
 
 	// status defines the observed state of {{ .Resource.Kind }}
 	// +optional
-	Status {{ .Resource.Kind }}Status ` + "`" + `json:"status,omitempty,omitzero"` + "`" + `
+	Status {{ .Resource.Kind }}Status ` + "`" + `json:"status,omitzero"` + "`" + `
 }
 
 // +kubebuilder:object:root=true
 
 // {{ .Resource.Kind }}List contains a list of {{ .Resource.Kind }}
 type {{ .Resource.Kind }}List struct {
 	metav1.TypeMeta ` + "`" + `json:",inline"` + "`" + `
-	metav1.ListMeta ` + "`" + `json:"metadata,omitempty"` + "`" + `
+	metav1.ListMeta ` + "`" + `json:"metadata,omitzero"` + "`" + `
 	Items           []{{ .Resource.Kind }} ` + "`" + `json:"items"` + "`" + `
 }