CI/CDの設定
GitHub Actionsを使って、PRの作成やマージをトリガーに設定の差分検出や反映を自動化できます。
概要
CI/CDでは、CLIコマンドをGitHub Actionsから実行することで、以下のような自動化が可能です。
- PR作成時:
bm push --dryで差分を検出し、PRにコメントする - PRマージ時:
bm pushで設定を開発環境に反映する - 環境デプロイ時:
bm deployで環境間のバージョンを同期する
ブランチ構成や環境の対応は、プロジェクトの運用に合わせて自由に設定できます。具体的な設定例は運用例をご参照ください。
セットアップ
1. GitHub Secretsの登録
始め方で発行したトークンを、GitHubリポジトリのSecretsに登録します。
2. GitHub Actionsの設定ファイル
プロジェクトをダウンロードすると、.github/ディレクトリにGitHub Actionsの設定ファイルが含まれています。
環境IDなどのプロジェクト固有の値は、ダウンロード時に自動で設定されます。
動作の流れ
PR作成時の差分検出
- PRが作成されると、CIが自動で
bm push --dryを実行します。 - 設定ファイルとベースマキナ上の設定の差分が検出されます。
- 差分の内容がPRにコメントとして投稿されます。
これにより、マージ前に設定変更の影響を確認できます。
PRマージ時の反映
- PRがマージされると、CDが自動で
bm pushを実行します。 - 設定の差分がベースマキナの開発環境に反映されます。
- 反映結果がPRにコメントとして投稿されます。
環境デプロイ
環境デプロイ用のブランチにマージすると、bm deployが実行され、環境間のバージョン同期が行なわれます。