docs: Fix installation instructions for golangci-lint v2 compatibility by krishagarwal278 · Pull Request #175 · kubernetes-sigs/kube-api-linter

krishagarwal278 · 2025-10-31T21:34:20Z

@JoelSpeed I've updated the README to fix the installation issues.

Main changes:

Module mode now uses v2.5.0 and includes the pseudo-version format you showed in the cluster-api example, plus instructions on how to generate it

Fixed the plugin build instructions to use the vendor directory like you suggested:

go mod vendor
go build -mod=vendor -buildmode=plugin -o bin/kube-api-linter.so ./vendor/sigs.k8s.io/kube-api-linter

Added version: "2" to all the .golangci.yml examples
Fixed up the Makefile and standalone build docs to be consistent with the actual directory structure

Fixes #145

krishagarwal278 · 2025-10-31T21:34:40Z

I've tested the standalone binary build with make build and it works fine. Let me know if anything needs adjusting!

JoelSpeed · 2025-11-03T10:57:22Z

.custom-gcl.yml

- module: 'sigs.k8s.io/kube-api-linter'
-  path: ./
+  - module: 'sigs.k8s.io/kube-api-linter'
+    version: 'v0.0.0-20251029172002-9992248f8813'


Probably still want this to point to the local path, this isn't an example necessarily but a way to build what's in the repo locally

JoelSpeed · 2025-11-03T10:58:57Z

Makefile

 .PHONY: build
 build: ## Build the golangci-lint custom plugin binary.
-	go build -o ./bin ./cmd/golangci-lint-kube-api-linter 
+	go build -o ./bin/golangci-lint-kube-api-linter ./cmd/golangci-lint-kube-api-linter 


Does this actually make a difference? On my machine the before and after appear to produce the same results

the build works the same for me. Reverted 👍🏻

JoelSpeed · 2025-11-03T11:03:28Z

README.md


 ```shell
-golangci-kube-api-linter run path/to/api/types --fix
+./bin/golangci-lint-kube-api-linter run path/to/api/types --fix


I guess generally we expect people to sort their own path, maybe we don't need to prefix the bin here?

JoelSpeed · 2025-11-03T11:03:58Z

README.md


 [golangci-lint-plugin-docs]: https://golangci-lint.run/plugins/go-plugins/

+**Important**: The plugin must be built from the vendor directory, not directly from the module path.


Is this true? Many projects don't use vendor, I expect they can still use the plugin no?

right just tested that locally, making vendor optional 👍🏻

JoelSpeed · 2025-11-03T11:04:30Z

README.md

+**Step 2**: Build the plugin from the vendor directory:
+
 ```shell
-go build -buildmode=plugin -o bin/kube-api-linter.so sigs.k8s.io/kube-api-linter/pkg/plugin


Losing pkg/plugin here is not correct. The root module is for module mode, the plugin path is for the plugin mode, they are different codepaths to build

everettraven · 2025-11-04T19:47:50Z

README.md

+To get the correct pseudo-version for the latest commit, run:
+
+```bash
+TZ=UTC git --no-pager show --quiet --abbrev=12 --date='format-local:%Y%m%d%H%M%S' --format="%cd-%h"
 ```


This is assuming they have a local version of kube-api-linter checked out right?

https://pkg.go.dev/sigs.k8s.io/kube-api-linter?tab=versions is probably a good source of truth for the latest version string

yeah that's right.
maybe suggesting to check the latest version as a better source of truth would be a better idea?

Suggested change

To get the correct pseudo-version for the latest commit, run:

```bash

TZ=UTC git --no-pager show --quiet --abbrev=12 --date='format-local:%Y%m%d%H%M%S' --format="%cd-%h"

```

To find the latest version listed, check [pkg.go.dev/sigs.k8s.io/kube-api-linter?tab=versions](https://pkg.go.dev/sigs.k8s.io/kube-api-linter?tab=versions)

everettraven · 2025-11-04T19:48:43Z

README.md


 ```yaml
+version: "2"
+


Any reason for this additional whitespace?

everettraven · 2025-11-04T19:49:48Z

README.md


-The output binary will be a combination of the initial `golangci-lint` binary and the Kube API linter plugin.
-This means that you can use any of the standard `golangci-lint` configuration or flags to run the binary, but may also include the Kube API Linter rules.
+The output binary `./bin/golangci-lint-kube-api-linter` will be a combination of the `golangci-lint` binary with the Kube API Linter included as a module.


will it always be ./bin/... as the pathing from golangci-lint custom?

everettraven · 2025-11-04T19:52:27Z

README.md

+go build -buildmode=plugin -o $(OUTPUT_DIR)/kube-api-linter.so sigs.k8s.io/kube-api-linter/pkg/plugin
+```
+
+Example - building into a `bin` directory:


do we need an explicit example of building into a specific directory?

yep, a single example should suffice too 👍🏻

krishagarwal278 · 2025-11-05T06:09:01Z

/label tide/merge-method-squash

everettraven

These changes look fine to me.

@JoelSpeed over to you for any additional comments.

/lgtm

JoelSpeed · 2025-11-06T13:21:24Z

/approve

k8s-ci-robot · 2025-11-06T13:21:33Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: everettraven, JoelSpeed, krishagarwal278

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [JoelSpeed]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot requested review from JoelSpeed and jpbetz October 31, 2025 21:34

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 31, 2025

JoelSpeed reviewed Nov 3, 2025

View reviewed changes

docs: Fix installation instructions for golangci-lint v2 compatibility

930e1c8

krishagarwal278 force-pushed the KAL-45 branch from 00be6aa to 930e1c8 Compare November 3, 2025 21:56

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 4, 2025

everettraven reviewed Nov 4, 2025

View reviewed changes

README.md Outdated

```yaml

version: "2"

Copy link

Contributor

everettraven Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason for this additional whitespace?

everettraven reviewed Nov 4, 2025

View reviewed changes

krishagarwal278 force-pushed the KAL-45 branch from c1ad844 to e9aa474 Compare November 5, 2025 05:14

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Nov 5, 2025

updated readme as per bryce's reviews

9ad19ec

krishagarwal278 force-pushed the KAL-45 branch from e9aa474 to 9ad19ec Compare November 5, 2025 14:44

everettraven approved these changes Nov 5, 2025

View reviewed changes

k8s-ci-robot assigned everettraven Nov 5, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 5, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 6, 2025

JoelSpeed merged commit eff876c into kubernetes-sigs:main Nov 6, 2025
4 checks passed

JoelSpeed mentioned this pull request Nov 6, 2025

📖 Update README.md - With instructions for GolangCI 2x #109

Closed


		[golangci-lint-plugin-docs]: https://golangci-lint.run/plugins/go-plugins/

		Important: The plugin must be built from the vendor directory, not directly from the module path.

Conversation

krishagarwal278 commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krishagarwal278 commented Oct 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krishagarwal278 commented Nov 5, 2025

Uh oh!

everettraven left a comment

Choose a reason for hiding this comment

Uh oh!

JoelSpeed commented Nov 6, 2025

Uh oh!

k8s-ci-robot commented Nov 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

krishagarwal278 commented Oct 31, 2025 •

edited

Loading