CI

どのようなものか

CIはcontinuous
integration、継続的インテグレーションの略です。チーム全員が一週間に
何度も、コードの変更を一つの共通の開発ラインへ取り込み、そのたびに機
械がビルドとテストを実行する進め方です。これにより、変更した本人がま
だ作業を覚えているうちに、誤りが表面化します。略称と同じくらい、継続
的インテグレーションという正式名称もよく使われます。

この言葉は二つの異なるものに使われるため、区別すると多くの混乱を避け
られます。一つ目は、人に関わる実践です。多くのチームが最終的に引用す
る出典となるMartin
Fowlerの記事は、習慣の集まりとして説明しています。メインラインを一つ
に保つ、ビルドを自動化する、ビルドに自己テストを組み込む、少なくとも
毎日メインラインへプッシュする、毎回のプッシュをビルドする、壊れたビ
ルドはすぐ直す、ビルドを速く保つ、未完成の作業はブランチに残すのでは
なく機能を隠す、全員がビルドの状態を見られるようにする、といった習慣
です。記事は名称の由来をExtreme
Programmingにたどり、それ以前にGrady Boochもこの表現を使っていたと記
しています。

二つ目は、機械です。「CIが赤い」と言うときは、ビルドを実行し、失敗を
報告したサービスを指します。GitHub
Actions、GitLab
CI/CDなどは、同じ構造を持っています。作業を定義するファイルをリポジ
トリへ置き、GitHubでは`.github/workflows/*.yml`、GitLabではルートの
`.gitlab-ci.yml`を使います。プッシュ、プルリクエストやマージリクエス
ト、スケジュール、人がボタンを押す操作などのイベントが、実行のきっか
けになります。専用に用意したマシンであるランナーがコミットをチェック
アウトし、そのファイルのコマンドを実行して、成功・失敗の結果を、その
コミットに関連付けて報告します。

サーバーだけでは、継続的インテグレーションにはなりません。作業を一か
月間ブランチに置き、サーバーで各ブランチをビルドするチームは、役立つ
ビルドの自動化を実現していますが、統合は最後にまとめて行っています。
実践の中心は頻繁なマージであり、機械はそれを続けられる程度に安全にす
る役割を担います。

継続的デリバリーと継続的デプロイは、その後に続く段階です。デリバリー
は、成功したビルドを常にリリース可能な状態に保ち、デプロイはそれぞれ
を自動的にリリースします。どちらも先にCIが整っていることを必要とする
ため、三つはCI/CDとしてまとめて書かれることがよくあります。

なぜ重要なのか

二つの作業系統をマージする負担は、別々に進めた期間に比例する以上に増
えます。昨日、同じモジュールを変更した二人なら、両方が意図を覚えてい
るため、数分で競合を解消できます。六週間前に分かれた二人は、差分から
意図を再構築することになります。小さな変更を頻繁にマージすれば、競合
も一つ一つ小さく保てます。機械が関わる前に、すでに効果の大部分が得ら
れます。

プッシュのたびにビルドすると、もう一つ加わります。同じ結果を確認でき
る、余計なもののないマシンです。「自分のノートパソコンでは動く」とい
うのは、独自にインストールしたライブラリーや残存ファイルを持つ、一台
のノートパソコンについての主張です。毎回、新しいチェックアウトから始
めるランナーは、同じ結果を再現するか、そのパソコン固有の条件を示しま
す。

価値を生むのは速さです。Fowlerの記事は、主要なビルドの目標を約十分間
としています。その理由は実務でも成り立ちます。プッシュから十分後に報
告された失敗は、変更がまだ画面にあるうちに、原因を作った人へ戻りま
す。翌朝の失敗は、たまたま見た人のもとへ届き、まず一時間かけて過去の
経緯を掘り起こすことになります。

可視性も重要です。メインラインの状態を全員に示せば、壊れたビルドを土
台に、そうと知らずに新しい作業を始める人はいなくなります。修復は誰か
他の人の問題ではなく、チームが最初に取り組む仕事になります。

CIはホステッドサービスである必要もありません。pre-commitは、コミット
やプッシュの前にGitフックとしてプロジェクトのチェックを実行し、文書
では同じ一式をサーバー上で`pre-commit
run
i--all-files`により実行する方法も示しています。Taskは、一つの		engineer.company	70
i`Taskfile.yml`で各チェックに名前を付け、人とランナーが同じコマンドを		engineer.company	70
i呼べるようにします。このサイトを支えるチェックも、そのモデルに従って		engineer.company	70
iいます。ページを執筆するローカル環境で動き、ホステッド型のビルドサー		engineer.company	70
iビスを挟まず、毎回のプッシュ前に全チェックを実行します。		engineer.company	70

実際の活用例

あるチームでは、手作業のリリースをやめたことで、約4,000時間を取り戻
しました。ソフトウェアの公開は、人によって少しずつ異なる手作業に頼っ
ていましたが、ビルド、テスト、デプロイの自動化で置き換えました。変更
から本番までの経路が、その場しのぎではなく標準的なものになり、リリー
スは速さと確実さの両方が向上しました。

長期運用のデータベースを持つあるプロジェクトでは、スキーマを二通りで
記述しています。一つは初期構築用、もう一つは036から1102までの番号が
付いた1,022本のマイグレーションです。変更のたびに、CIジョブが両方の
方法でデータベースを構築します。一方は新規用のスキーマから、もう一方
はすべてのマイグレーションを順に再実行して作り、構造と初期投入データ
を比較します。二つに違いがあれば、ジョブは失敗し、その差を出力しま
す。これにより、新しい環境と長く使った環境が同じデータベースになるこ
とを、推測ではなくチェックで確認できます。

CIは、一つのアプリケーションの二つの部分の整合性も保てます。別のプロ
ジェクトでは、データベースを起点とする生成処理の連鎖から、APIの記述
とフロントエンドのクライアントを作っています。クライアントだけでも、
型付きTypeScriptが44,076行あります。CIチェックは、フロントエンドが送
る内容をAPIが期待する内容と照合し、食い違えばビルドを失敗させます。
これこそCIが目指す結果です。片側だけで変わったフィールドが、利用者の
ブラウザーでのエラーになる前に、変更から数分後のビルドで失敗として見
つかります。

問題が起きるところ

CIの仕組みの多くは、突然壊れるのではなく、徐々に劣化します。以下はど
れも小さく始まり、最後には、チームが回避しながら作業することに慣れた
ビルドになります。

作業そのものより、ビルドに時間がかかります。
プッシュの結果が返るまで四十分かかるようになると、人は待つのをやめ、
複数の変更をまとめてプッシュし、その頻度も下げます。実践の目指す方向
とは逆です。ハードウェアを追加する前に、どこで時間を使っているかを測
定します。依存関係をキャッシュし、速いチェックから実行し、遅いテスト
群は第二段階かスケジュール実行へ移し、主要なビルドを十分間程度に保ち
ます。

メインラインが一日中失敗したままです。
誰も直さない壊れたビルドが通常の状態になり、二つ目の失敗が最初の陰に
隠れて入ってきます。防ぐルールは明快です。壊した人が今すぐ直すか、変
更を元に戻し、修正には自分の時間を使います。ビルドが成功しているメイ
ンラインこそが、他の全員の開発の土台です。

サーバーが各ブランチをビルドしていても、ブランチが何週間も残っていま
す。
すべてのブランチは成功を示し、マージした日に問題が一度に現れます。こ
れは統合を伴わない、ビルドの自動化です。少なくとも毎日メインラインへ
マージし、未完成の機能は分離したままにするのではなく、無効にしておき
ます。

サーバーとノートパソコンで、チェックの一覧が違います。
手作業で管理する二つのコマンド一覧はずれていき、変更がローカルでは成
功してサーバーで失敗したり、その逆になったりして、どちらも信頼されな
くなります。チェックの入口を一つにし、両方から呼びます。pre-commitな
ら、サーバーでも各開発者とまったく同じフックを実行できます。

```yaml
i# .gitlab-ci.yml		engineer.company	70
check:
    image: python:3.13
    script:
        - pip install pre-commit
        - pre-commit run --all-files --show-diff-on-failure
```

不安定なテストのせいで、全員が再実行ボタンを押すようになります。
変更とは関係のない理由で二十回に一回失敗するテストは、チームに、結果
を読むより再実行する習慣を付けます。その後は、本当の失敗も同じように
扱われます。そのテストを隔離し、修正するか削除します。頻繁に押される
再実行ボタンは、それ自体を問題の兆候として扱います。

参考資料

  * 継続的インテグレーション：Martin Fowlerの詳しい記事です。各実
践、十分間のビルド、名称の由来を説明します。

  * GitHub Actionsを理解する：GitHub自身の定義に沿って、ワークフ
ロー、イベント、ジョブ、ランナーを説明します。

  * GitLab
CI/CD：GitLabの用語に沿って、`.gitlab-ci.yml`、パイプライン、ステー
ジ、ジョブ、ランナーを説明します。

  *
pre-commit：設定ファイルで一度だけ定義したチェックを、Gitフックとし
て実行し、CIサーバーの手順としても実行する方法を説明します。

  *
Task：各チェックに一つの名前を付け、人とランナーが同じコマンドを入力
できるようにする`Taskfile.yml`を説明します。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/ci/	engineer.company	70
