GitHub Actionsを使って、Pythonのコードをプッシュするたびにflake8でチェックする

GitHub Actionsが登場してしばらく経つもののまだ使ったことがなかったのと、あとは仕事でPython素人の人に教える機会がちょこちょこあって、コードのチェックも機械的にやりたかったので、ググりつつやってみました。

結果、多少落とし穴もあったのでメモ。

今回やること

PythonのコードをGitHubのリポジトリにPushした際に、Flake8を使ってコードをレビューし、グリーンやレッドで表示させる。

なお、実際やった結果は以下リポジトリに置いてあります。（READMEも作ってないですが）

YoshikiIto/python-github-action

手順

１．リポジトリにActionを追加

まずはリポジトリにActionを追加します。

GitHub Marketplace · Actions to improve your workflowにアクセスすると、Actionの検索ができます。ここで今回はflake8と検索します。

いくつかActionが表示されます。

小さくstar数も表示されているのですが、何らかの基準があっての順番だと思うので、おとなしく一番左上のものを選択。

github acitons

ここにActionの細かい使い方等々が書いてあるので参考にしつつ、右上のUse latest versionを選択。

github acitons

ダイアログが出てきて、コピーするスニペットが出てきます。

コレをコピーすればOK・・・かと思いきやそういうわけでもなかったので注意してください。コピーは自体は必要です。

github acitons

次にActionを設定したいリポジトリのActionsタブを開きます。

Actionが設定されていない場合は下のような画面が出てくるので、リンクになっているset up a workflow yourselfをクリック。

github acitons

workflowの内容はYAMLで設定します。CircleCIで言うところのconfig.yml相当ですね。

ここで先程ダイアログで出てきたスニペットを貼り付ければOK、というわけではなく、実際にはflake8のインストールなど、他のコマンドも自分で書く必要がありました。

github acitons

ymlの内容は以下です。Actionによって内容が異なるので、参考までに。

# This is a basic workflow to help you get started with Actions

name: Lint

on:
  push:
    paths:
      - '*.py'

jobs:
  flake8_py3:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Python
        uses: actions/setup-python@v1
        with:
          python-version: 3.8.3
          architecture: x64
      - name: Checkout PyTorch
        uses: actions/checkout@master
      - name: Install flake8
        run: pip install flake8
      - name: Run flake8
        uses: suo/flake8-github-action@releases/v1
        with:
          checkName: 'flake8_py3'   # NOTE: this needs to be the same as the job name
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}