Skip to content

docs: add note about binary requirement for plugin #3468

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 12, 2023
Merged

docs: add note about binary requirement for plugin #3468

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a05bd86
docs: add note about binary requirement for plugin
philiplinell Jan 11, 2023
2e9d00a
review
ldez Jan 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/src/docs/contributing/new-linters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ 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
Expand Down