KPA experimental install

Author: camilamacedo86

Makefile

@@ -131,8 +131,18 @@ yamllint:
     	docker run --rm $$(tty -s && echo "-it" || echo) -v $(PWD):/data cytopia/yamllint:latest $$files -d "{extends: relaxed, rules: {line-length: {max: 120}}}" --no-warnings
 
 .PHONY: golangci-lint
-golangci-lint:
+golangci-lint: $(GOLANGCI_LINT)
+
+$(GOLANGCI_LINT): $(LOCALBIN)
 	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,${GOLANGCI_LINT_VERSION})
+	@if [ -f .custom-gcl.yml ]; then \
+		echo "Installing custom golangci-lint plugins..."; \
+		$(LOCALBIN)/golangci-lint custom --config .custom-gcl.yml || { \
+			echo "golangci-lint custom failed. Cleaning up..."; \
+			rm -f $(LOCALBIN)/golangci-lint; \
+			exit 1; \
+		}; \
+	fi
 
 .PHONY: apidiff
 apidiff: go-apidiff ## Run the go-apidiff to verify any API differences compared with origin/master

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

@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-custom-linters
+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,25 +21,37 @@ linters:
     - unconvert
     - unparam
     - unused
-  settings:
-    revive:
-      rules:
-        - name: comment-spacings
-        - name: import-shadowing
-  exclusions:
-    generated: lax
+    - kubeapilinter
+linters-settings:
+  revive:
     rules:
-      - linters:
-          - lll
-        path: api/*
-      - linters:
-          - dupl
-          - lll
-        path: internal/*
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
+      - name: comment-spacings
+      - name: import-shadowing
+  custom:
+    - name: kubeapilinter
+      path: ./bin/golangci-custom-linters
+      description: "Kube API Linter plugin"
+      original-url: "sigs.k8s.io/kube-api-linter"
+      settings:
+        linters: {}
+        lintersConfig: {}
+exclusions:
+  generated: lax
+  rules:
+    - linters:
+        - lll
+      path: api/*
+    - linters:
+        - dupl
+        - lll
+      path: internal/*
+    - path-except: "^api/"
+      linters:
+        - kubeapilinter
+  paths:
+    - third_party$
+    - builtin$
+    - examples$
 formatters:
   enable:
     - gofmt

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

@@ -232,6 +232,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 --config .custom-gcl.yml || { \
+		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

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

@@ -0,0 +1,7 @@
+version: v2.0.0
+name: golangci-custom-linters
+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,25 +21,37 @@ linters:
     - unconvert
     - unparam
     - unused
-  settings:
-    revive:
-      rules:
-        - name: comment-spacings
-        - name: import-shadowing
-  exclusions:
-    generated: lax
+    - kubeapilinter
+linters-settings:
+  revive:
     rules:
-      - linters:
-          - lll
-        path: api/*
-      - linters:
-          - dupl
-          - lll
-        path: internal/*
-    paths:
-      - third_party$
-      - builtin$
-      - examples$
+      - name: comment-spacings
+      - name: import-shadowing
+  custom:
+    - name: kubeapilinter
+      path: ./bin/golangci-custom-linters
+      description: "Kube API Linter plugin"
+      original-url: "sigs.k8s.io/kube-api-linter"
+      settings:
+        linters: {}
+        lintersConfig: {}
+exclusions:
+  generated: lax
+  rules:
+    - linters:
+        - lll
+      path: api/*
+    - linters:
+        - dupl
+        - lll
+      path: internal/*
+    - path-except: "^api/"
+      linters:
+        - kubeapilinter
+  paths:
+    - third_party$
+    - builtin$
+    - examples$
 formatters:
   enable:
     - gofmt

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

@@ -228,6 +228,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 --config .custom-gcl.yml || { \
+		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

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

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