Content-Length: 2758 | pFad | http://github.com/coderabbitai/coderabbit-docs/pull/407.patch

thub.com From 7525bb265b7cdace80a8f2cc2976904ee140fff9 Mon Sep 17 00:00:00 2001 From: Jolyon Direnko-Smith Date: Sun, 22 Jun 2025 07:26:28 +1200 Subject: [PATCH] docs: update golangci-lint docs (#406) - document the use of v1 - document configuring parallel use of v1 and v2 linters for the same project for code review and CI/Cd, respectively; OR suggest to disable linting in code reviews to avoid a warning - provide links to both v1 and v2 configuration documentation --- docs/tools/golangci-lint.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/tools/golangci-lint.md b/docs/tools/golangci-lint.md index ba140553..8002eeb9 100644 --- a/docs/tools/golangci-lint.md +++ b/docs/tools/golangci-lint.md @@ -12,6 +12,26 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; [golangci-lint](https://golangci-lint.run/) is a fast Go linters runner. +## Supported Version + +At this time, CodeRabbit uses v1.x of the `golangci-lint` tool. + +If you have a `golangci-lint v2` configuration file in your project, you will see a warning in CodeRabbit reviews and CodeRabbit will not be able to use `golangci-lint` to inform review comments. + +There are two ways to avoid this warning. + +### 1. Parallel Support for v1 (code review) and v2 (CI/CD) Linting + +This will allow v2 linting in CI/CD pipelines while also enabling CodeRabbit to use v1.x linting for review comments. + +- Provide a golangci-lint `version: "1"` configuration file that will not be used by golangci-lint itself, e.g. `.coderabbit-golangci.yml` + +- Set `reviews.tools.golangci-lint.config_file` to reference that file in a `.coderabbit.yaml` file + +### 2. Disable golangci-lint in CodeRabbit + +- Set `reviews.tools.golangci-lint.enabled` to false in a `.coderabbit.yaml` file in your project. + ## Files golangci-lint will run on files with the following extensions: @@ -21,7 +41,7 @@ golangci-lint will run on files with the following extensions: ## Configuration -golangci-lint supports the following config files: +golangci-lint supports v1 configuration files as follows: - User-defined config file set at `reviews.tools.golangci-lint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → golangci-lint → Config File" field in CodeRabbit's settings page. - `.golangci.yml` @@ -31,4 +51,5 @@ golangci-lint supports the following config files: ## Links -- [golangci-lint Configuration](https://golangci-lint.run/usage/configuration/) +- [golangci-lint v1 Configuration](https://golangci.github.io/legacy-v1-doc/usage/configuration/) +- [golangci-lint v2 Configuration](https://golangci-lint.run/usage/configuration)

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!