Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: update golangci-lint docs (#406) #407

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update golangci-lint docs (#406) #407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 23 additions & 2 deletions docs/tools/golangci-lint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`
Expand All @@ -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)