GitHub Actionsを使ってgolangci-lintを設定しよう！

概要

GitHub Actions内でLinterを使用することでGOのソースコードを解析して、バグの検出や、言語のルールに沿ってコードが書かれているかをチェックすることができます
今回はgolangci-lintを使ったワークフローを作成する方法について解説します

前提

• GOのプロジェクトを作成済み

golang-ci-lintとは

GOで使用できるLinterの一つで実行時に公式のgovetをはじめとする様々なLinterを一緒に使用できるのが特徴です

ディレクトリ構成

├── .env
├── .github
│   └── workflows
│       └── lint.yml
└── backend
    ├── go.mod
    ├── go.sum
    └── main.go

実装

以下がワークフローです
詳細はこのあと解説します

lint.yml

name: Lint Code

on:
  pull_request:
    types: [opened, reopened, synchronize, ready_for_review]
    branches-ignore:
      - 'release/**'
      - 'doc/**'

env:
  WORKING_DIRECTORY: backend

jobs:
  lint:
    if: |
      github.event.pull_request.draft == false
      && !startsWith(github.head_ref, 'release')
      && !startsWith(github.head_ref, 'doc')
    name: Lint
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ${{ env.WORKING_DIRECTORY }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Golang
        uses: actions/setup-go@v5
        with:
          go-version-file: ${{ env.WORKING_DIRECTORY }}/go.mod
          cache: true
          cache-dependency-path: |
            **/go.sum
            **/go.mod
      - name: Install Dependencies
        run: go mod download
      - name: Lint Code
        uses: golangci/golangci-lint-action@v6
        with:
          version: v1.60
          working-directory: ${{ env.WORKING_DIRECTORY }}

setup-go

公式が出しているsetup-goを使用することでGOの環境設定を行うことができます
go-version-fileを指定することでgo.modファイル内のGOのバージョンを自動で検出します
また、cache: trueにすることでキャッシュを使ってインストールを高速化します
cache-dependency-pathに下記のようにgo.sumとgo.modファイルを指定します

      - name: Setup Golang
        uses: actions/setup-go@v5
        with:
          go-version-file: ${{ env.WORKING_DIRECTORY }}/go.mod
          cache: true
          cache-dependency-path: |
            **/go.sum
            **/go.mod

golangci-lint用のActions

golangci-lintが公式で出しているActionsを使用します
公式ドキュメントによると公式のActionsを使用するとgolangci-lintをバイナリインストールするより早くインストールできるので推奨しているとのことです

      - name: Lint Code
        uses: golangci/golangci-lint-action@v6
        with:
          version: v1.60
          working-directory: ${{ env.WORKING_DIRECTORY }}

実際に実行してみよう！

以下のようにワークフロー実行時にLinterが適用され、エラーを検知した場合はPR上にエラー箇所を表示できれば成功です

参考