AWS CodePipline 指定リポジトリのmasterブランチにpushされたら動くように設定する

Last updated at 2023-12-13Posted at 2023-12-13

概要

指定のGithubのリポジトリのmasterブランチにpushイベントが発生したらCodePiplineが動作するように設定を行う。
本記事は完全な手順紹介の記事ではなく、体験記的な側面が強い。したがって一部の設定内容はご自身の環境に読み替えて頂く必要がある。

前提

Githubのアカウントが存在し、今回作業するブラウザでGithubにログインできていること。

基本的な設定項目

先に決定しておいたほうが良い内容を下記に記載しておく。

項目	制約や選択や内容	備考
パイプライン名	100文字以下有効文字は`A-Za-z0-9.@-_`のみ	パイプライン作成後に変更できない
パイプラインタイプ	「V1」 or 「V2」から選択	それぞれで機能と価格が異なる V1: 作成時にコスト発生、標準のパイプライン（「masterブランチが更新されたらパイプライン動作開始」） V2: アクション実行1分あたりコストが発生、パラメーター化されたパイプラインが使える、V1の機能は全て使えてプラスアルファの機能がある（「このGitタグがあったらパイプライン動作開始」など詳細なトリガー設定が可能） V1 V2どちらが良いか迷ったらこちらを参照
サービスロール	「新しいサービスロール」の作成 or 「既存のサービスロール」を流用から選択	AWSサービスに紐付けるIAMのロールのことパイプライン作成時にロールを作りたいなら「新しいサービスロール」を選べば良いすでにパイプラインを作成済みでロールを使いまわしたいなら「既存のサービスロール」を選択すれば良い
ロール名	有効文字は`A-Za-z0-9.@-_`のみ	サービスロールで「新しいサービスロール」を選択すると入力欄が表示パイプライン名をから自動設定自動設定ロール名は`AWSCodePipelineServiceRole-ap-northeast-1-`の後ろにパイプライン名が入る
ロールのARN	既存のIAMロールのARNの値を入力して検索する	サービスロールで「既存のサービスロール」を選択するとARN入力欄が表示
ソースプロバイダー	CodeCommitやGithubなどをプルダウンで選択	パイプラインで監視する対象のソースを選択プルダウンで選択後、ソースプロバイダーへの接続情報が表示される。
接続（ソースプロバイダーでGithub2を選んだ場合）	Githubとの接続設定を実施	当該AWSとGithubの紐づけ
リポジトリ名（ソースプロバイダーでGithub2を選んだ場合）	Github内のリポジトリ名を検索・設定
パイプライントリガー（ソースプロバイダーでGithub2を選んだ場合）	「ブランチにプッシュイン」 or 「Gitタグ」or 「なし」から選択	「ブランチにプッシュイン」: 後から選ぶブランチにpushが合ったときに動作「Gitタグ」: パイプラインタイプV2じゃないと使用不可「なし」: パイプライン手動実行 or スケジュール実行のどちらかになる
出力アーティファクト形式（ソースプロバイダーでGithub2を選んだ場合）	「CodePiplineのデフォルト」 or 「完全クローン」から選択

方法

暫定デプロイで使う任意のS3バケットを作成する。（オブジェクトのバージョニングはONにしておく。それ以外はデフォルト設定でOK）
AWSにブラウザでログインし、CodePiplineの画面を開く。
「開始方法」から「パイプラインの開始」をクリックする。
下記の情報をそれぞれ入力する。（→の先は今回の設定内容）
1. パイプライン名（100文字以下、日本語不可） → laravel10-deploy
2. パイプラインタイプ（「V1」と「V2」より選択） → 「V2」
3. サービスロール（「新しいサービスロール」と「既存のサービスロール」より選択） → 「新しいサービスロール」
4. ロール名（日本語不可） → パイプライン名から自動生成されたものをそのまま使用
入力できたら「次に」をクリックする。
ソースを選択する。ソースプロバイダーの選択にてプルダウンから「GitHub（バージョン2）」を選択する。
接続の項目の「GitHubに接続する」のボタンをクリックする。
別ウインドウが開くのでまずは接続先名を入力する。（接続名とはAWSがGithubに接続するときの設定名と思っていただきたい。必ずしも接続先のGithubのアカウント名などと一致している必要はないはず。）
接続名を入力し、「Githubに接続する」をクリックすると画面が変わる。「新しいアプリをインストール」をクリックする。
Githubのログインユーザーとオーガニゼーションの一覧が表示されるので、接続したいワークスペースを選択する。
筆者はすでにこの作業を完了してしまっているため下記のようにAWS Connector for GitHubというアプリが導入済みとして表示された。みなさんはもう少しポチポチして当該のアプリケーションを導入する必要があるかもしれない。
すべて設定が終わると小さなウインドウが閉じて、AWSの画面に戻ってくるはずである。「接続」の部分に先程設定したGitHubとの接続情報が選択されているはずである。
リポジトリ名の部分をクリックして、今回監視するリポジトリ名を選択する。筆者は「test」という下記のリポジトリを選択した。
- https://github.com/miriwo0104/test
「masterブランチにpushが合ったときにPiplineを動かしたい」が今回の要望なので下記の様に設定した。
1. パイプライントリガー（「ブランチにプッシュイン」か「Gitタグ」か「なし」から選択） → 「ブランチにプッシュイン」
2. ブランチ名 → master
全部設定したら「次に」をクリックする。
CodeBuildは設定しないため「ビルドステージをスキップ」をクリックする。
CodeDeployは他の記事で別途設定方法を指定するため、今回は暫定のものを設定する。
プルダウンでS3を選択する。適当なバケットを指定して本当に適当に設定する。（暫定なため）
レビューページで内容を確認し、特に問題なさそうなら「パイプラインを作成する」をクリックする。