本文へ移動
BenriWorks LabBenriWorks トップ

ガイド更新日

GitHub Actionsで、変更の検査を自動にする

この記事で分かること

Codex 集中講座の第13回。型検査、テスト、リンク検査をGitHub Actionsで実行する流れを学びます。成功や失敗のログを読み、人が確認する部分との役割を分けます。

検査の結果が並んだ画面を背に、こちらを向いて腕を組んでいる男性
目次 読みたいところから

手元ではテストが通った。でも、プルリクエストにも同じ検査結果を残しておきたい。変更を取り込む前に、決まったコマンドを実行する仕組みを用意します。

GitHub Actionsで、型検査やテストを自動実行します。結果の正しさをコマンドで確かめられる部分を任せ、使いやすさや変更の目的は人が読みます。

何を機械に任せられるか

判断の線引きは単純です。答えが一意に決まるものは機械、決まらないものは人。

型の不一致は一意に決まります。書式の乱れも決まります。テストが通るかどうかも決まります。これらは全部、機械のほうが速くて正確です。

一方、その設計でよいか、この変更が利用者にとって意味があるか、説明が分かりやすいかは決まりません。人が読むしかない。

AIに書かせる量が増えると、この区別の価値が上がります。出てくる量が増えても、人が読む速さは変わらないからです。読む対象を減らす手段として、機械の検査が効いてきます。

実際のワークフロー

BenriWorks のブログで動いているものを、そのまま載せます。

name: CI

on:
  push:
    branches: [main]
  pull_request:

jobs:
  ci:
    name: typecheck / lint / test / content / build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm

      - name: 依存関係のインストール
        run: npm ci

      - name: TypeScript型検査
        run: npm run typecheck

      - name: ESLint
        run: npm run lint

      - name: 単体テスト
        run: npm run test

      - name: コンテンツスキーマ・slug重複・関連先・画像存在検証
        run: npm run validate:content

      - name: 内部リンク・画像参照検査
        run: npm run check:links

      - name: Production build
        run: npm run build

読み方を上から追います。

on が、いつ走らせるかです。プルリクエストが作られたときと更新されたとき、そして本番用ブランチへ反映されたとき。第8回で決めた「止まる場所」に合わせています。

runs-on が、どんな環境で走らせるかです。GitHub 側が用意する使い捨ての機械で、毎回きれいな状態から始まります。だから、手元の環境に残っているものに依存していないかが、この仕組みで自動的に確かめられます。

steps が、上から順に実行される作業です。1つでも失敗すると、そこで止まって全体が失敗になります。

GitHub Actionsの実行結果の画面。依存関係のインストールが11秒、TypeScript型検査が5秒、ESLintが5秒、単体テストが2秒、コンテンツの検証が0秒、内部リンクの検査が1秒、Production buildが16秒と上から順に並び、全体は52秒で成功している
上のワークフローが実際に走った結果。1つでも落ちれば、そこで止まる画像を拡大(別タブ)

並べる順番で待ち時間が変わる

手順の並びには意図があります。速くて落ちやすいものが前、遅いものが後ろです。

型検査は数十秒で終わり、よく落ちます。ビルドは数分かかります。型が通らないコードはビルドも通らないので、先に型検査で落としておけば、ビルドの時間を使わずに済みます。

同じ理屈で、テストは検査系の後ろに置いています。書式の乱れで落ちるなら、テストを走らせる前に分かったほうが速い。

品質ゲートの並び順を示した図。型検査、書式検査、テスト、コンテンツ検証、リンク検査、ビルドの順に並び、左ほど速く落ちやすく右ほど時間がかかることと、途中で失敗すると後続が実行されないことが示されている
速くて落ちやすいものを前へ。落ちる変更ほど早く結果が出る

この並びは、開発の体感をかなり変えます。うまくいかない変更ほど早く結果が返るので、待ち時間の多くが「通る変更を待つ時間」になります。

自分の仕事に合わせた検査を足す

上のワークフローの中に、一般的でない項目が2つあります。validate:content と check:links です。

これはメディアサイトの仕事に特有の検査です。記事の設定項目が仕様どおりか、記事の識別子が重複していないか、参照先の記事が実在するか、指定した画像ファイルが実際に置かれているか。内部リンクの検査は、リンク先が存在しないページを指していないかを見ています。

どちらも、書かれた文章の良し悪しとは無関係な、機械で決まる検査です。そして、人が一番見落としやすい種類でもあります。記事を読み直すとき、リンク先を1つずつ開いて確かめる人はいません。

自分の仕事で「毎回確認するのを忘れて、あとで困ること」が何かを考えると、足すべき検査が見えてきます。BenriWorks の場合はリンク切れと画像の欠落でした。

似た例として、別のアプリでは、アクセス解析のタグが正しい文字列として書き出されるかを検査する項目を足しました。実際に構文の誤りで計測が止まったことがあり、その再発を止めるために入れたものです。事故が起きたら検査を1つ足すという進め方は、第9回の規約の育て方と同じです。

Codex 側の検査との関係

AGENTS.md に書いた検査コマンドと、ここで走らせる検査は、同じものを指しています。

役割は違います。Codex 側の検査は、書いた本人が手元で確かめるものです。GitHub Actions の検査は、手元の環境に依存しない状態で確かめるものです。

食い違いが出たときに、その差が情報になります。手元では通るのに GitHub Actions で落ちるなら、手元の環境に何かが残っています。入れたはずの依存が記録されていない、生成されるはずのファイルが手で置かれている、といった原因が典型です。

通らないと反映できない状態にする

検査を作っても、落ちたまま反映できるなら意味が半分になります。

第8回で触れたブランチの保護設定に、ここで1つ足します。指定した検査が通っていることを、反映の条件にする設定です。これを入れると、落ちているプルリクエストはマージのボタンが押せなくなります。

自分で運用していると、「今回は急ぐから」と通してしまう場面が必ず来ます。ボタンが押せなければ、その選択肢自体がなくなります。判断の機会を減らすことが、仕組みの一番の効き目です。

落ちたときに何をするか

検査が落ちたら、失敗した手順の記録を読みます。GitHub の画面で、落ちた項目を開くと出力が出ます。

この出力を Codex に渡すのが一番速い直し方です。エラーの文面をそのまま貼って、直してもらいます。第6回の3つでいえば、エラーの出力が文脈にあたります。

ただし、落ちた理由が分からないまま直してもらわないでください。型検査が落ちたときに、型の宣言を緩めて通すこともできます。それは通っただけで、直っていません。出力を自分でも読み、何が起きたかを理解してから渡してください。理解できないなら、そこは Codex に説明させる依頼を先に出します。

ワークフローと結果を照らし合わせる

本文のワークフローから、型検査、テスト、コンテンツ検証のコマンドを探します。GitHubの実行結果が見られる場合は、同じ名前の手順とログを開いてください。

失敗した場合に、どのコマンドの、どの出力を読めばよいか説明できれば、調べる入口ができています。

次の回

検査が通った変更にも、挙動や読み落としを確認する余地があります。Codexへレビューを頼む方法を整理します。「Codexのクラウド作業と、GitHubでのレビュー」へ進めます。

参照した情報

  • GitHub Actions のワークフロー構文に関する公式ドキュメント(docs.github.com)
  • 引用したワークフローは BenriWorks のブログリポジトリで実際に動いているもの

READ NEXT

次はこれを読む

Codex 集中講座の次の回へ

Codexのクラウド作業と、GitHubでのレビュー

Codex 集中講座の第14回。クラウドで進める作業と、プルリクエストのレビューを整理します。自動検査、Codexの指摘、人の確認がそれぞれ何を見るかを比べます。

続きを読む →
レビューコメントが並んだ画面の前で、こちらを向いて考えている女性

よくある質問

個人の小さなプロジェクトでも必要ですか
AIに書かせる量が増えるほど、必要になります。人が読む速さは変わらないので、機械で判定できる部分を先に落としておかないと、読む対象が増える一方になります。最初は型検査とテストの2つだけでも効果があります。
検査に時間がかかると開発が遅くなりませんか
並べ方で変わります。速くて落ちやすいものを前に置けば、落ちる変更は数十秒で結果が出ます。ビルドのような時間のかかるものを最後に置くと、通らないものにビルドの時間を使わずに済みます。
Codex に検査を通させるのと、GitHub Actions で検査するのは重複しませんか
役割が違います。Codex 側の検査は、書いた本人が手元で確かめるものです。GitHub Actions の検査は、手元の環境に依存しない状態で確かめるものです。手元では通るのに他の環境では落ちる、という食い違いを見つけるのが後者の仕事になります。