CI/CDパイプラインの設計
この章では、アプリケーションとインフラを一気通貫に自動化する CI/CD パイプラインを設計する課題に取り組みます。
1. 目的・背景
静的解析・自動テスト、コンテナ、Terraform でコード化したインフラを、GitHub Actions で一気通貫に自動化します。アプリケーションのコード変更もインフラの設定変更も、ブランチへの push を起点に安全に本番へ反映される流れを整えることが目標です。
本章ではその第一段階として、要件に沿ったパイプラインの設計を行い、提出します。メンターからフィードバックを受け、必要に応じて設計を修正してください。設計の誤りが実装に波及するのを防ぐため、設計のフィードバックを受けてから次章 CI/CDパイプラインの実装 に進んでください。
| 💡 ポイント |
|---|
| 本課題は、要件定義や設計を自分で考えるスキルを高めるため、要件をあえて抽象的に記載しています。進める中で不明点がある場合は、講師への質問 から事前に相談してください。メンタリング当日に「わからなくて進んでいない」状態になると活用できる時間が限られてしまうため、迷ったら途中段階でもこまめに質問を出すことを推奨します。 |
2. 設計要件
2.1 アプリケーションの CI/CD
sns-camp-api に対して、以下の一連の処理を GitHub Actions で自動化する前提で設計してください。
- 静的解析(プログラミング講座で組み込んだツールを実行)
- 自動テスト(プログラミング講座で組み込んだテストを実行)
- コンテナイメージのビルドとレジストリへのプッシュ
- コンテナ実行環境へのデプロイ
2.2 インフラの CI/CD
Terraform 講座でコード化した Terraform に対して、以下を GitHub Actions で自動化する前提で設計してください。
- Pull Request 作成時に
terraform planを実行し、変更内容を確認できる - 特定のブランチへのマージ時に
terraform applyを実行し、変更が反映される
2.3 ブランチ戦略
本番反映に使うブランチ、開発中の変更を集めるブランチ、個別の変更を扱うブランチをどう使い分けるかを決めてください。各ブランチへの push/merge が、どのワークフローを起動するかを整理してください。
2.4 デプロイ方式(任意)
アプリケーションのデプロイ方式として、Blue/Green デプロイメントなど無停止で切り替えができる方式を採用するかどうかを検討してください。リリース中のダウンタイムをなくし、問題があった場合に旧環境へすぐ切り戻せるようにすることが目的です。
2.5 ブランチ保護(任意)
本番反映されるブランチに対して、レビュー通過・CI パス・直接プッシュ禁止などの保護設定を行うかどうかを検討してください。レビューや自動チェックを通過していない変更が本番に紛れ込まないようにし、事故を未然に防ぐことが目的です。
3. 課題提出
下記内容を提出フォームより提出してください(提出はプレミアムプランでご利用いただけます)。
| 項目 | 内容 |
|---|---|
| 概要 | 設計した CI/CD パイプラインの全体像と、カバーしている範囲を簡潔に記載する |
| ワークフロー一覧 | 用意する GitHub Actions のワークフローごとに、起動契機(push/pull_request など)、対象ブランチ、実行するジョブ、成功時の反映先を表形式で記載する |
| ブランチ戦略 | 採用するブランチ構成(例: main / develop / feature 等)と、各ブランチへの変更がどのワークフローを起動するかを記載する |
| デプロイ方式(任意) | デプロイ方式を採用する場合は、採用する方式とその理由を記載する |
| ブランチ保護(任意) | ブランチ保護を設定する場合は、保護するブランチと保護ルール(必須レビュー数・必須チェック・直接プッシュ禁止など)を記載する |
| まとめ | 設計を考える過程で検討したこと、工夫したこと、学んだこと |