KPA experimental install

camilamacedo86 · camilamacedo86 · commit 444bd362a01e · 2025-07-20T20:02:56.000+01:00
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/.custom-gcl.yaml b/docs/book/src/cronjob-tutorial/testdata/project/.custom-gcl.yaml
@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml b/docs/book/src/cronjob-tutorial/testdata/project/.golangci.yml
@@ -21,11 +21,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -36,6 +43,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/docs/book/src/cronjob-tutorial/testdata/project/Makefile b/docs/book/src/cronjob-tutorial/testdata/project/Makefile
@@ -224,6 +224,12 @@ $(ENVTEST): $(LOCALBIN)
 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))
+	@echo "Running golangci-lint custom..."
+	@$(LOCALBIN)/golangci-lint custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(LOCALBIN)/golangci-lint; \
+		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
diff --git a/docs/book/src/getting-started/testdata/project/.custom-gcl.yaml b/docs/book/src/getting-started/testdata/project/.custom-gcl.yaml
@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
diff --git a/docs/book/src/getting-started/testdata/project/.golangci.yml b/docs/book/src/getting-started/testdata/project/.golangci.yml
@@ -21,11 +21,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -36,6 +43,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/docs/book/src/getting-started/testdata/project/Makefile b/docs/book/src/getting-started/testdata/project/Makefile
@@ -220,6 +220,12 @@ $(ENVTEST): $(LOCALBIN)
 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))
+	@echo "Running golangci-lint custom..."
+	@$(LOCALBIN)/golangci-lint custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(LOCALBIN)/golangci-lint; \
+		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
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/.custom-gcl.yaml b/docs/book/src/multiversion-tutorial/testdata/project/.custom-gcl.yaml
@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/.golangci.yml b/docs/book/src/multiversion-tutorial/testdata/project/.golangci.yml
@@ -21,11 +21,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -36,6 +43,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/docs/book/src/multiversion-tutorial/testdata/project/Makefile b/docs/book/src/multiversion-tutorial/testdata/project/Makefile
@@ -224,6 +224,12 @@ $(ENVTEST): $(LOCALBIN)
 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))
+	@echo "Running golangci-lint custom..."
+	@$(LOCALBIN)/golangci-lint custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(LOCALBIN)/golangci-lint; \
+		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
diff --git a/pkg/plugins/golang/v4/scaffolds/init.go b/pkg/plugins/golang/v4/scaffolds/init.go
@@ -174,6 +174,7 @@ func (s *initScaffolder) Scaffold() error {
 		&templates.DockerIgnore{},
 		&templates.Readme{CommandName: s.commandName},
 		&templates.Golangci{},
+		&templates.CustomGcl{},
 		&e2e.Test{},
 		&e2e.WebhookTestUpdater{WireWebhook: false},
 		&e2e.SuiteTest{},
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/customgcl.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/customgcl.go
@@ -0,0 +1,51 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package templates
+
+import (
+	"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
+)
+
+var _ machinery.Template = &CustomGcl{}
+
+// CustomGcl scaffolds a file .custom-gcl.yaml which define KAL configuration to install
+type CustomGcl struct {
+	machinery.TemplateMixin
+	machinery.ProjectNameMixin
+}
+
+// SetTemplateDefaults implements machinery.Template
+func (f *CustomGcl) SetTemplateDefaults() error {
+	if f.Path == "" {
+		f.Path = ".custom-gcl.yaml"
+	}
+
+	f.TemplateBody = customGCLTemplate
+
+	f.IfExistsAction = machinery.SkipFile
+
+	return nil
+}
+
+const customGCLTemplate = `version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
+`
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/golangci.go
@@ -64,11 +64,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -79,6 +86,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go b/pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go
@@ -299,6 +299,12 @@ $(ENVTEST): $(LOCALBIN)
 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))
+	@echo "Running golangci-lint custom..."
+	@$(LOCALBIN)/golangci-lint custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(LOCALBIN)/golangci-lint; \
+		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
diff --git a/testdata/project-v4-multigroup/.custom-gcl.yaml b/testdata/project-v4-multigroup/.custom-gcl.yaml
@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
diff --git a/testdata/project-v4-multigroup/.golangci.yml b/testdata/project-v4-multigroup/.golangci.yml
@@ -21,11 +21,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -36,6 +43,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4-multigroup/Makefile b/testdata/project-v4-multigroup/Makefile
@@ -220,6 +220,12 @@ $(ENVTEST): $(LOCALBIN)
 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))
+	@echo "Running golangci-lint custom..."
+	@$(LOCALBIN)/golangci-lint custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(LOCALBIN)/golangci-lint; \
+		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
diff --git a/testdata/project-v4-with-plugins/.custom-gcl.yaml b/testdata/project-v4-with-plugins/.custom-gcl.yaml
@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
diff --git a/testdata/project-v4-with-plugins/.golangci.yml b/testdata/project-v4-with-plugins/.golangci.yml
@@ -21,11 +21,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -36,6 +43,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4-with-plugins/Makefile b/testdata/project-v4-with-plugins/Makefile
@@ -220,6 +220,12 @@ $(ENVTEST): $(LOCALBIN)
 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))
+	@echo "Running golangci-lint custom..."
+	@$(LOCALBIN)/golangci-lint custom || { \
+		echo "golangci-lint failed. Cleaning up..."; \
+		rm -f $(LOCALBIN)/golangci-lint; \
+		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
diff --git a/testdata/project-v4/.custom-gcl.yaml b/testdata/project-v4/.custom-gcl.yaml
@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-kube-api-linter
+destination: ./bin
+
+plugins:
+  - module: sigs.k8s.io/kube-api-linter
+    version: latest
diff --git a/testdata/project-v4/.golangci.yml b/testdata/project-v4/.golangci.yml
@@ -21,11 +21,18 @@ linters:
     - unconvert
     - unparam
     - unused
+    - kubeapilinter
   settings:
     revive:
       rules:
         - name: comment-spacings
         - name: import-shadowing
+    custom:
+      kubeapilinter:
+        type: "module"
+        description: Kube API LInter lints Kube like APIs based on API conventions and best practices.
+        linters: { }
+        lintersConfig: { }
   exclusions:
     generated: lax
     rules:
@@ -36,6 +43,9 @@ linters:
           - dupl
           - lll
         path: internal/*
+      - path-except: "^api/"
+        linters:
+          - kubeapilinter
     paths:
       - third_party$
       - builtin$
diff --git a/testdata/project-v4/Makefile b/testdata/project-v4/Makefile
