Golangci-lint GitHub Action 使用教程

1. 项目介绍

Golangci-lint 是一个用于 Go 语言的静态代码分析工具，它集成了多个 linters，可以帮助开发者快速发现代码中的潜在问题。golangci-lint-action 是 Golangci-lint 的官方 GitHub Action，允许用户在 GitHub Actions 中自动运行 golangci-lint，并报告代码中的问题。

2. 项目快速启动

2.1 安装 Golangci-lint

首先，确保你已经安装了 Golangci-lint。你可以通过以下命令安装：

go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

2.2 配置 GitHub Action

在你的 GitHub 仓库中，创建一个 .github/workflows/golangci-lint.yml 文件，并添加以下内容：

name: golangci-lint

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  golangci:
    name: lint
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: stable
      - name: golangci-lint
        uses: golangci/golangci-lint-action@v6
        with:
          version: v1.60

2.3 运行 GitHub Action

提交并推送你的更改，GitHub Actions 将自动运行 golangci-lint，并在代码中发现问题时报告。

3. 应用案例和最佳实践

3.1 多操作系统支持

如果你需要在多个操作系统上运行 golangci-lint，可以使用以下配置：

name: golangci-lint

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  golangci:
    strategy:
      matrix:
        go: [stable]
        os: [ubuntu-latest, macos-latest, windows-latest]
    name: lint
    runs-on: $[{ matrix.os }]

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: $[{ matrix.go }]
      - name: golangci-lint
        uses: golangci/golangci-lint-action@v6
        with:
          version: v1.60

3.2 使用自定义插件

如果你需要使用自定义的 linters（插件），可以参考以下示例：

name: golangci-lint with plugins

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  golangci:
    name: lint
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: stable
      - name: Build and install plugins
        run: |
          git clone https://github.com/golangci/example-plugin-linter.git
          cd example-plugin-linter
          go build -o '$GITHUB_WORKSPACE/plugins/example.so' -buildmode=plugin plugin/example.go
        working-directory: ${{ runner.temp }}
        env:
          CGO_ENABLED: 1
      - name: golangci-lint
        uses: golangci/golangci-lint-action@v6
        with:
          version: v1.60
          install-mode: goinstall
          args: --timeout=5m

4. 典型生态项目

4.1 Golangci-lint 插件示例

golangci-lint-action-plugin-example 是一个示例项目，展示了如何在 golangci-lint 中使用自定义插件。你可以通过以下链接访问该项目：

Golangci-lint-action-plugin-example

4.2 Golangci-lint 官方 GitHub Action

golangci-lint-action 是 Golangci-lint 的官方 GitHub Action，提供了在 GitHub Actions 中运行 golangci-lint 的功能。你可以通过以下链接访问该项目：

Golangci-lint-action

通过这些项目，你可以更好地理解和使用 golangci-lint 及其生态系统。