Github Actions いいですよね!使いやすいです。
この記事では golangci-lint
と misspell
のチェックをするための Githuba Actions の設定方法について説明します。
Github Actions を動作させるためには
.github/workflows/*.yaml というファイルを設定します。
公式が参考になります。
https://docs.github.com/ja/actions/quickstart
golangci-lint と misspell チェックの CI を追加する
.github/workflows/lint.yaml などの名称で以下のファイルを作成してください。
name: lint
on:
push:
tags:
- v*
branches:
- master
- develop
pull_request:
jobs:
golangci:
name: run golangci-lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: golangci-lint
uses: reviewdog/action-golangci-lint@v2
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
misspell:
name: run misspell
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: reviewdog/action-misspell@v1
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review
この yaml を追加した上で commit し Github 上で PR を作成すると以下のようになります(もしくは Repository の Actions のタブを見ても良いです)。
さらに、あえてスペルミスがあるような修正を commit&push すると yaml に設定した reviewdog が PR に直接コメントをしてくれます。
CircleCI を利用する場合は lint や misspell の設定ファイルの準備や Makefile などでスクリプトを作成しておく必要があるので、こういう定型の CI 処理は Github Actions で設定する方が楽で手軽で良いですね。