reviewdog/action-golangci-lint

GitHub Action：使用reviewdog运行golangci-lint

https://github.com/reviewdog/action-golangci-lint/workflows/Docker%20Image%20CI/badge.svg](https://github.com/reviewdog/action-golangci-lint/actions) https://github.com/reviewdog/action-golangci-lint/workflows/depup/badge.svg](https://github.com/reviewdog/action-golangci-lint/actions?query=workflow%3Adepup) https://github.com/reviewdog/action-golangci-lint/workflows/release/badge.svg](https://github.com/reviewdog/action-golangci-lint/actions?query=workflow%3Arelease) https://img.shields.io/badge/bumpr-supported-ff69b4?logo=github&link=https://github.com/haya14busa/action-bumpr](https://github.com/haya14busa/action-bumpr)

镜像概述

该GitHub Action镜像用于在拉取请求（Pull Request）中运行https://github.com/golangci/golangci-lint%E4%BB%A3%E7%A0%81%E6%A3%80%E6%9F%A5%E5%B7%A5%E5%85%B7%EF%BC%8C%E5%B9%B6%E9%80%9A%E8%BF%87https://github.com/reviewdog/reviewdog%E5%B0%86%E6%A3%80%E6%9F%A5%E7%BB%93%E6%9E%9C%E7%9B%B4%E8%A7%82%E5%B1%95%E7%A4%BA%E5%9C%A8PR%E9%A1%B5%E9%9D%A2%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%9B%A2%E9%98%9F%E6%8F%90%E5%8D%87%E4%BB%A3%E7%A0%81%E5%AE%A1%E6%9F%A5%E6%95%88%E7%8E%87%E5%92%8C%E8%B4%A8%E9%87%8F%E3%80%82

核心功能

• 集成golangci-lint，支持多维度代码检查（语法错误、代码风格、性能优化、安全隐患等）
• 通过reviewdog将检查结果标注在PR差异页、检查页或状态检查中，便于开发者快速定位问题
• 支持自定义golangci-lint参数、reviewdog报告方式及过滤规则
• 可灵活配置工作目录、报告级别及错误处理策略

使用场景

• GitHub仓库拉取请求的自动化代码审查流程
• 团队Go项目的代码质量管控，提前发现潜在问题
• 持续集成（CI）流程中嵌入代码检查环节，确保代码规范

配置说明

输入参数

• github_token：必填，默认值为${{ github.token }}，使用预构建镜像时需显式设置为github_token: ${{ secrets.github_token }}
• golangci_lint_flags：可选，golangci-lint运行参数（格式：golangci-lint run --out-format=line-number <参数>），也可通过https://github.com/golangci/golangci-lint#configuration%E8%B0%83%E6%95%B4%E8%A1%8C%E4%B8%BA
• tool_name：可选，reviewdog报告的工具名称，用于区分不同配置的Action实例
• level：可选，报告级别（info/warning/error），与reviewdog的-level参数一致
• workdir：可选，相对于根目录的工作目录
• reporter：可选，reviewdog报告方式（github-pr-check/github-pr-review），与reviewdog的-reporter参数一致
• filter_mode：可选，过滤模式（added/diff_context/file/nofilter），默认值为added
• fail_on_error：可选，发现错误时是否退出（true/false），默认值为false
• reviewdog_flags：可选，reviewdog额外参数

部署示例

最小使用示例

.github/workflows/reviewdog.yml

yml
name: reviewdog
on: [pull_request]
jobs:
  golangci-lint:
    name: runner / golangci-lint
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码到Go模块目录
        uses: actions/checkout@v1
      - name: 运行golangci-lint
        uses: reviewdog/action-golangci-lint@v1

高级使用示例

.github/workflows/reviewdog.yml

yml
name: reviewdog
on: [pull_request]
jobs:
  # 注意：golangci-lint在同一行不会报告来自不同linter的多个错误，只会显示其中一个
  golangci-lint:
    name: runner / golangci-lint
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码到Go模块目录
        uses: actions/checkout@v1
      - name: 运行golangci-lint
        uses: reviewdog/action-golangci-lint@v1
        with:
          # 可通过--config参数修改golangci-lint行为和目标目录
          golangci_lint_flags: "--config=.github/.golangci.yml ./testdata"
          workdir: subdirectory/

  # 通过golangci-lint二进制文件运行golint，级别为warning
  golint:
    name: runner / golint
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码到Go模块目录
        uses: actions/checkout@v1
      - name: 运行golint
        uses: reviewdog/action-golangci-lint@v1
        with:
          golangci_lint_flags: "--disable-all -E golint"
          tool_name: golint # 修改报告工具名称
          level: warning # 此级别下GitHub状态检查不会失败

  # 可添加更多支持的linter并配置不同参数
  errcheck:
    name: runner / errcheck
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码到Go模块目录
        uses: actions/checkout@v1
      - name: 运行errcheck
        uses: reviewdog/action-golangci-lint@v1
        with: 
          golangci_lint_flags: "--disable-all -E errcheck"
          tool_name: errcheck
          level: info          

无配置文件的全功能golangci-lint配置

.github/workflows/reviewdog.yml

yml
name: reviewdog
on: [pull_request]
jobs:
  golangci-lint:
    name: runner / golangci-lint
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码到Go模块目录
        uses: actions/checkout@v1
      - name: 运行golangci-lint
        uses: reviewdog/action-golangci-lint@v1
        with:
          golangci_lint_flags: "--enable-all --exclude-use-default=false"