Skip to content

Commit d13d0ca

Browse files
philiplinellSeigeC
authored andcommitted
docs: add note about binary requirement for plugin (golangci#3468)
1 parent 5bdf8a6 commit d13d0ca

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: docs/src/docs/contributing/new-linters.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ Some people and organizations may choose to have custom-made linters run as a pa
4141
Typically, these linters can't be open-sourced or too specific.
4242
Such linters can be added through Go's plugin library.
4343

44+
For a private linter (which acts as a plugin) to work properly,
45+
the plugin as well as the golangci-lint binary needs to be built for the same environment. `CGO_ENABLED` is another requirement.
46+
This means that `golangci-lint` needs to be built for whatever machine you intend to run it on
47+
(cloning the golangci-lint repository and running a `CGO_ENABLED=1 make build` should do the trick for your machine).
48+
4449
### Configure a Plugin
4550

4651
If you already have a linter plugin available, you can follow these steps to define it's usage in a projects

0 commit comments

Comments
 (0)