静的解析の実施

リポジトリの準備が整ったので、いよいよGitHub Actionsのワークフローを作成していきます。CIの最初のステップは静的解析です。静的解析を最初に行う理由は、コードを実行せずに構文上の問題やコードスタイルの崩れを検出できるため、テストといった後工程に進む前に早い段階で問題を発見できるからです。「実行して初めて気づくエラー」を減らせるため、開発者へのフィードバックが速くなります。

ここでは、Python用の静的解析ツールであるflake8を使用します。

1. 静的解析の概要

今回は、Pythonの静的解析をGitHub Actionsのワークフローに組み込みます。トリガーとしては、mainブランチへのPull Requestが作成された際にワークフローが実行されるように設定します。Pull Requestの作成時にチェックすることで、「レビュー前の段階で基本的な品質問題を自動検知する」という流れを作れます。

処理の流れは以下のとおりです。

  • GitHubリポジトリからコードをチェックアウトする
  • Pythonのランタイムをセットアップする
  • 静的解析ツール(flake8)をインストールする
  • flake8でコードスタイルや文法上の問題を検出する

これらの流れを、GitHub Actionsのワークフローとして構築します。

2. 作業用ブランチの作成

ワークフローファイルを追加する前に、作業用のブランチを作成します。ブランチを分けずにmainブランチに直接コミットしてしまうと、今回作成するワークフロー(mainへのPull Request作成時に動作)のトリガーを試せなくなってしまいます。「Pull Requestを作って → CIが動いて → マージする」という実務的な流れを体験するためにも、作業用ブランチを作っておきましょう。

Visual Studio Codeのターミナルで、以下のgit switchコマンドを実行してfeature/add-ci-workflowというブランチを作ります。-cオプションは新しいブランチを作成して切り替えるという意味です。

git switch -c feature/add-ci-workflow

Switched to a new branch 'feature/add-ci-workflow'と表示されていれば、ここまでの操作は完了です。

3. ワークフローファイルの作成

ブランチの準備ができたので、GitHub Actionsのワークフローファイルを作成していきます。GitHub Actionsのワークフローは、リポジトリ内の.github/workflowsフォルダに配置したYAMLファイルで定義します。GitHubがこのフォルダ内のYAMLファイルを自動的に検出してワークフローとして認識する仕組みになっているため、このルールに沿ってファイルを作成します。

今回はcode-check.ymlというファイル名でワークフローを作成します。

devopscamp-ci-handson/
└── .github/
    └── workflows/
        └── code-check.yml  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

name: Python Code Check

on:
  pull_request:
    branches:
      - main

jobs:
  python-lint:
    name: Run python-lint
    runs-on: ubuntu-latest

    steps:
      # ソースコードのチェックアウト
      - name: Checkout code
        uses: actions/checkout@v5

      # Python環境をセットアップ
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.11'

      # 静的解析ツールをインストール
      - name: Install flake8
        run: pip install flake8

      # flake8で静的解析を実行
      - name: Run flake8
        run: flake8 .

4. ワークフローの説明

作成したワークフローの中身を解説します。

4.1 名称

name: Python Code Check

ワークフローの名称として、Python Code Checkという名前をつけています。GitHub Actionsの画面ではこの名前でワークフローが一覧表示されます。

4.2 トリガー

on:
  pull_request:
    branches:
      - main

トリガーとして、mainブランチに対してPull Requestが作成された時に起動するように設定しています。Pull Requestの作成時だけでなく、Pull Requestに対して追加のコミットがPushされたときにも再実行されます。

4.3 ジョブ

jobs:
  python-lint:
    name: Run python-lint
    runs-on: ubuntu-latest

ジョブとして、python-lintというジョブを定義しています。名前にRun python-lint、ランナーとしてubuntu-latestを指定しているため、Ubuntuの最新のランナー環境で動作します。

4.4 ステップ1:コードのチェックアウト

- name: Checkout code
  uses: actions/checkout@v5

Pull Requestをトリガーに実行された場合、GitHubは自動的にマージ先(例: main)とPull Request元(例: featureブランチ)を一時的にマージした「仮のマージコミット」を作成し、それをチェックアウトします。そのため、このステップでは、mainブランチやfeatureブランチそのものではなく、両者を統合した一時的なマージ結果が実行環境に展開されます。実際のmainブランチへのマージはこの時点ではまだ行われていません。

actions/checkout@v5に対する詳細は、こちらのGitHubリポジトリに記載されています。

actions/checkout

4.5 ステップ2:Pythonのセットアップ

- name: Set up Python
  uses: actions/setup-python@v6
  with:
    python-version: '3.11'

Pythonのランタイムをセットアップします。flake8はPythonで動作するツールのため、これを実行するにはCI環境にPythonランタイムがインストールされている必要があります。actions/setup-pythonアクションを使用することで、指定したバージョンのPythonランタイムを簡単にインストールできます。ここでは3.11を指定しています。

actions/setup-python@v6に対する詳細は、こちらのGitHubリポジトリに記載されています。

actions/setup-python

4.6 ステップ3:静的解析ツールのインストール

- name: Install flake8
  run: pip install flake8

pip install flake8で、静的解析ツールのflake8をインストールします。

4.7 ステップ4:flake8の実行

- name: Run flake8
  run: flake8 .

flake8 .コマンドで、カレントディレクトリ配下のすべてのPythonコードに対してコードスタイルや文法上の問題を検出します。未使用のインポートや不適切なインデント、長すぎる行などを警告してくれます。

解析結果は、GitHub Actionsの実行結果として表示されます。

5. 動作確認

ワークフローファイルの作成が完了しました。ただし、ローカルにファイルを作成しただけではGitHub Actionsは動作しません。GitHub ActionsはGitHub上のリポジトリに対して動作する仕組みのため、作成したワークフローファイルをGitHubにPushしてはじめて認識されます。ここでは、ファイルをPushしてPull Requestを作成し、実際にワークフローが動くかを確認します。

サンプルコードのcalculator.pyには意図的にimport os(未使用のインポート)を入れています。また、コードブロックをコピーして貼り付けた場合、ファイルの末尾に改行が入らないことがあります。これらの問題がflake8で検出されることを確認した上で、修正して正常終了させるまでの一連の流れを体験します。

5.1 GitHubへのPush

まず、今回作成した内容をGitHubにPushしていきます。Visual Studio Codeのターミナルで、以下のコマンドを1つずつ実行します。

ファイルをステージングします。

git add .

コミットします。

git commit -m "add lint workflow"

Pushします。

git push origin feature/add-ci-workflow

5.2 Pull Requestの作成

コードのPushが完了しましたが、今回作成したワークフローは「mainブランチへのPull Requestが作成された時」に起動するように設定しているため、ワークフローを動かすにはPull Requestを作成する必要があります。続いて、Pull Requestの作成を行います。

GitHubのリポジトリページを開き、Pull requestsタブをクリックします。

New pull requestのボタンをクリックします。

ブランチとして、左側のbaseにmain、右側のcompareにfeature/add-ci-workflowを選択した上で、Create pull requestをクリックします。

タイトルと説明欄はそのままで問題ありません。さらにCreate pull requestをクリックします。

5.3 警告の確認

Pull Requestの画面が開いたら、中央部分にPython Code Check / Run python-lintのワークフローが実行されていることが読み取れます。ワークフロー名をクリックすると、実行状況の詳細画面が開きます。

しばらくすると、実行結果がエラーになり、赤いバツマークが表示されます。

エラーとなっているRun flake8のステップを開くと、以下のような警告が表示されています。

./calculator.py:1:1: F401 'os' imported but unused
./calculator.py:3:1: E302 expected 2 blank lines, found 1
./calculator.py:8:17: W292 no newline at end of file

それぞれの警告の意味は以下のとおりです。

F401 'os' imported but unused

import osでインポートしていますが、コード内でosが一度も使われていません。未使用のインポートはコードの可読性を下げるため、削除すべきです。

E302 expected 2 blank lines, found 1

PEP 8では、トップレベルの関数定義の前には2行の空行を入れるルールがあります。import osとdef addの間の空行が1行しかないため、この警告が出ています。import osを削除すれば、この警告も一緒に解消されます。

W292 no newline at end of file

ファイルの末尾に改行がありません。PEP 8やPOSIXの標準では、テキストファイルの末尾には改行を入れるルールがあります。

Pull Requestの画面を見ても赤いバツが付いています。このように、CIによって「問題のあるコードが混入しそうになったら、自動で気付ける」というフィードバックを得られます。これがCIの最も大きなメリットです。

5.4 警告の修正

警告の原因がわかったので、コードを修正していきます。Visual Studio Codeでcalculator.pyを開き、以下の2点を修正します。

  • 先頭のimport osの行と、その下の空行を削除する(F401とE302が解消される)
  • ファイルの末尾(return a - bの行末)でEnterキーを1回押して改行を入れる(W292が解消される)

修正したら、GitHubにPushします。

git add .
git commit -m "fix lint errors"
git push origin feature/add-ci-workflow

5.5 正常終了の確認

Pull Requestの画面で、Python Code Checkのワークフローが再実行されます。しばらく待つと、ワークフローが正常終了します。Run flake8のステップ部分を展開すると、警告が出ずに静的解析が正常終了していることが確認できます。

Pull Requestの画面に戻ると、緑のチェックマークが付いています。これが「静的解析をパスした」状態です。

「問題のあるコードをPush → CIがエラーを検知 → 修正してPush → CIが正常終了」というサイクルを体験できました。実務でもこの流れの繰り返しで、コードの品質を保っていきます。ここまでの操作が完了です。