テーマ別の解説テーマ:CI/CDの設計:検査から配信と回復まで
CI/CDパイプラインの設計:依存関係・成果物・配信先をつなぐ
パイプラインは、各工程の入力・出力・実行条件をつないだ処理の設計です。上から順に緑になる図だけでは、並行処理や古い成果物の混入を説明できません。架空Webアプリの変更を、ソースの版から成果物・配信先まで追います。
工程の依存を図で読み、同じ対象の検査結果と成果物を後段へ渡す条件を説明できる。
CIは変更へ早く検査結果を返す進め方です。成果物(artifact)はビルド等で作ったファイル群。この例のA/Bは説明用の名前で、実コミットIDや実ハッシュ値ではありません。
各工程で、何を受け取り何を渡す?
| 工程 | 入力 | 出力と成功条件 |
|---|---|---|
| 単体テスト | ソースBと固定入力 | Bの定義済みテストが実行され、期待と一致。 |
| ビルド | ソースB、依存・ビルド設定 | 成果物Bと、入力版・ビルド条件の記録。 |
| 成果物の検査 | 成果物B、テスト結果B | 配信するファイルそのものを確認した記録。 |
| 公開判定 | Bの記録、成果物B、配信先prod | 対象の一致・必要検査・承認等を確認。 |
| 配信と照合 | 承認された成果物Bとprod | 実際に使われる版と必要な動作を照合。 |
ソースrevisionは材料の版、成果物は配信するバイト、配信先は使う場所です。同じソースでも、依存・設定・生成時刻の埋込み等が違えば成果物が同じとは限りません。名前が同じzipでも、中身を識別する記録が必要です。
並行にできる工程と、待つ工程を分ける
- ソースB → テストBBを読む
- ソースB → 成果物Bを作るBから生成
- テストB → 成果物Bを検査Bの結果が必要
- 成果物Bを作る → 成果物Bを検査成果物Bが必要
- 成果物Bを検査 → 公開判定候補の記録を渡す
- ソースB
- 入力の版と設定を固定。
- テストB
- 固定入力と期待を比較。
- 成果物Bを作る
- ビルド入力も記録。
- 成果物Bを検査
- 両方の記録を照合。
- 公開判定
- 対象・検査・宛先を確認。
図は時間の長さや処理中の進捗を示しません。テストとビルドは、例では互いを前提にしないため並行にできます。成果物検査は両方を待ちます。実際の開始時刻はrunnerの空きや実行条件にも左右されます。
GitHub Actionsではjob間の依存をneedsで指定します。前提jobの失敗やskipにより後段もskipされるのが基本ですが、条件式で例外を定められます。結果の収集を失敗後にも行う処理と、失敗を無視して配信する処理を区別してください。
反例:Bの検査成功と、成果物Aの取り違え
| 記録 | ソース | 成果物 | 判断 |
|---|---|---|---|
| 今回のテスト | B | ソースの検査のみ | Bへの検査として使う。 |
| 今回のビルド | B | B | 候補はB。 |
| 配信jobが取得したzip | A | A | Bの候補とは違うため停止。 |
P2ではBの成功を、Aの公開許可として使えません。成果物を保存するときに、入力revision・実行識別子・成果物のハッシュ等を対応させ、取得側でも照合します。ハッシュは同じバイトかを調べる材料で、作成者や安全性そのものの保証ではありません。
Actionsのartifactはjobが作ったファイルを保存・共有する機能です。依存キャッシュは再取得等を減らす目的で、配信する成果物の選定とは区別します。キャッシュが無くても必要な依存を復元できる設計と、意図した成果物を検証して使う設計を両立させます。
ステージングでの成功を、本番の成功にしない
同じ成果物Bでも、接続先DB・環境変数・権限・ネットワーク・secretの参照先が変われば動作は変わります。環境差分を一覧にし、配信先の指定、設定の検査、切替後に利用者へ返る結果を別に確認します。ログへsecretを出して比較する方法は使いません。
CDは文脈によって継続的デリバリー(配信できる状態を保つ)と継続的デプロイメント(条件を満たす変更を本番へ自動反映する)のどちらも指します。チーム内で意味と最終操作の判断者を明示します。パイプラインを自動化しても、人の承認を必ず除くという意味ではありません。
障害時にも、対象を追える設計にする
- 各工程の入力・出力・必要な権限と実行条件を書く。
- 互いに依存しない工程と、両方の結果が必要な工程を分ける。
- ソース・実行・成果物・宛先の対応を保存し、後段で確認する。
- 失敗・未実行・中断・承認待ちを、成功と別に扱う。
- 再実行時に古い成果物や古い承認を流用しない条件を決める。
- 配信後の照合と、異常時に戻せる範囲を決める。
依存関係と対象の一致を確かめる
選択すると、正誤と理由が表示されます。
確認して、自分の言葉で説明する
- P1で並行に動ける工程と依存を説明する。
- ソース・成果物・宛先を識別する。
- P2で停止すべき理由を示す。
- 失敗・再実行・本番照合の条件を決める。
理解を確かめる: 本番でBをもう一度ビルドした。ローカル検査した成果物Bと同一とみなせる?
みなせません。依存・設定等で出力が変わり得ます。検査済みの成果物を使うか、再生成した候補のバイト・入力条件と必要な検査を改めて照合します。
材料の版、出来上がった物、使う場所を分けて追います。
出典と確認した条件
説明に用いた公式資料を、確認した内容・条件と本文の参照箇所に分けてまとめています。専門家による監修・実際のAWSとの比較検証は行っていません。
確認した内容・条件needsによる依存、失敗・skip時の後段と条件による例外。実行順はYAMLの掲載順とは限らない。 公式資料を確認。実GitHub/AWSの検証ではありません。
参照した本文並行にできる工程と、待つ工程を分ける
確認した内容・条件実行で作ったファイルの保存・job間共有。依存キャッシュと配信する成果物を区別。 公式資料を確認。実GitHub/AWSの検証ではありません。
参照した本文反例:Bの検査成功と、成果物Aの取り違え
確認した内容・条件デリバリーは公開できる状態を保つ。デプロイメントは条件通過後の本番自動反映。採用方式・最終判断を明示する。 公式資料を確認。実GitHub/AWSの検証ではありません。
参照した本文ステージングでの成功を、本番の成功にしない