From a05bd8639c06f881025f4946ae6a0e8ccfbc1419 Mon Sep 17 00:00:00 2001 From: Philip Linell <linell@hey.com> Date: Wed, 11 Jan 2023 09:47:58 +0100 Subject: [PATCH 1/2] docs: add note about binary requirement for plugin The binary releases aren't compatible with private linters. This commit adds a section in the new linters documentation that describes the requirements for private linters to work. --- docs/src/docs/contributing/new-linters.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/docs/contributing/new-linters.mdx b/docs/src/docs/contributing/new-linters.mdx index ec38b2671791..9f1e63635eba 100644 --- a/docs/src/docs/contributing/new-linters.mdx +++ b/docs/src/docs/contributing/new-linters.mdx @@ -41,6 +41,8 @@ Some people and organizations may choose to have custom-made linters run as a pa Typically, these linters can't be open-sourced or too specific. Such linters can be added through Go's plugin library. +For a private linter (which acts as a plugin) to work properly, the plugin as well as the golangci-lint binary needs to be built for the same environment. `CGO_ENABLED` is another requirement. This means that `golangci-lint` needs to be built for whatever machine you intend to run it on (cloning the golangci-lint repository and running a `CGO_ENABLED=1 make build` should do the trick for your machine). + ### Configure a Plugin If you already have a linter plugin available, you can follow these steps to define it's usage in a projects From 2e9d00a771531d1bbd23f43cb9f17256e67f7e60 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic <ldez@users.noreply.github.com> Date: Thu, 12 Jan 2023 14:33:14 +0100 Subject: [PATCH 2/2] review --- docs/src/docs/contributing/new-linters.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/src/docs/contributing/new-linters.mdx b/docs/src/docs/contributing/new-linters.mdx index 9f1e63635eba..55f5c4a065ee 100644 --- a/docs/src/docs/contributing/new-linters.mdx +++ b/docs/src/docs/contributing/new-linters.mdx @@ -41,7 +41,10 @@ Some people and organizations may choose to have custom-made linters run as a pa Typically, these linters can't be open-sourced or too specific. Such linters can be added through Go's plugin library. -For a private linter (which acts as a plugin) to work properly, the plugin as well as the golangci-lint binary needs to be built for the same environment. `CGO_ENABLED` is another requirement. This means that `golangci-lint` needs to be built for whatever machine you intend to run it on (cloning the golangci-lint repository and running a `CGO_ENABLED=1 make build` should do the trick for your machine). +For a private linter (which acts as a plugin) to work properly, +the plugin as well as the golangci-lint binary needs to be built for the same environment. `CGO_ENABLED` is another requirement. +This means that `golangci-lint` needs to be built for whatever machine you intend to run it on +(cloning the golangci-lint repository and running a `CGO_ENABLED=1 make build` should do the trick for your machine). ### Configure a Plugin