ワークフローへのトリガーの追加

Amazon CodeCatalyst ワークフローにプッシュ、プル、またはスケジュールトリガーを追加するには、以下の手順に従います。

トリガーについての詳細は、「トリガーを使用してワークフローを自動的に開始する」を参照してください。

Visual

トリガーを追加するには (ビジュアルエディタ）

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。
プロジェクトを選択します。
ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。
ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。
[編集] を選択します。
ビジュアル を選択します。
ワークフロー図で、ソースボックスとトリガーボックスを選択します。
設定ペインで、トリガーの追加 を選択します。

トリガーの追加ダイアログボックスで、次のようにフィールドに情報を入力します。

トリガータイプ

トリガーのタイプを指定します。次のいずれかの値を使用できます。

プッシュ (ビジュアルエディタ) または PUSH (YAMLエディタ）

プッシュトリガーは、変更がソースリポジトリにプッシュされたときにワークフロー実行を開始します。ワークフローの実行では、プッシュ先のブランチ (つまり、送信先ブランチ) 内のファイルを使用します。
プルリクエスト (ビジュアルエディタ) または PULLREQUEST (YAMLエディタ）

プルリクエストトリガーは、ソースリポジトリでプルリクエストがオープン、更新、またはクローズされたときにワークフロー実行を開始します。ワークフローの実行では、プル元のブランチ (ソースブランチ) 内のファイルを使用します。
スケジュール (ビジュアルエディタ) または SCHEDULE (YAML エディタ）

スケジュールトリガーは、指定した cron 式で定義されたスケジュールでワークフロー実行を開始します。ブランチのファイルを使用して、ソースリポジトリ内のブランチごとに個別のワークフロー実行が開始されます。（トリガーがアクティブ化されるブランチを制限するには、ブランチフィールド (ビジュアルエディタ) またはBranchesプロパティ (YAMLエディタ) を使用します）。

スケジュールトリガーを設定するときは、次のガイドラインに従ってください。
- ワークフローごとに 1 つのスケジュールトリガーのみを使用します。
- CodeCatalyst スペースに複数のワークフローを定義している場合は、同時に開始するように 10 個までスケジュールすることをお勧めします。
- トリガーの cron 式は、実行間隔を十分に設定してください。詳細については、「Expression」を参照してください。

例については、「例: ワークフローのトリガー」を参照してください。

プルリクエストのイベント

このフィールドは、プルリクエストトリガータイプを選択した場合のみ表示されます。

ワークフロー実行を開始するプルリクエストイベントのタイプを指定します。有効な値は次のとおりです。

プルリクエストが作成される (ビジュアルエディタ) または OPEN (YAMLエディタ）

ワークフローの実行は、プルリクエストの作成時に開始されます。
プルリクエストがクローズされている (ビジュアルエディタ) または CLOSED (YAMLエディタ）

ワークフロー実行は、プルリクエストが閉じられたときに開始されます。CLOSED イベントの動作はトリッキーで、例から最もよく理解できます。詳細については、「例: プル、ブランチ、およびCLOSED「」イベントを含むトリガー」を参照してください。
プルリクエスト (ビジュアルエディタ) または ( エディタ) に新しいリビジョンが加えられました REVISION YAML

ワークフロー実行は、プルリクエストのリビジョンが作成されると開始されます。最初のリビジョンは、プルリクエストの作成時に作成されます。その後、プルリクエストで指定されたソースブランチに誰かが新しいコミットをプッシュするたびに、新しいリビジョンが作成されます。プルリクエストトリガーREVISIONにイベントを含めると、がのスーパーセットであるため、OPENイベントREVISIONを省略できますOPEN。

同じプルリクエストトリガーで複数のイベントを指定できます。

例については、「例: ワークフローのトリガー」を参照してください。

スケジュール

このフィールドは、スケジュールトリガータイプを選択した場合にのみ表示されます。

スケジュールされたワークフロー実行をいつ実行するかを記述する cron 式を指定します。

の Cron 式では、次の 6 つのフィールド構文 CodeCatalyst を使用します。各フィールドはスペースで区切られます。

minutes hours days-of-month month days-of-week year

cron 式の例

分	時間	曜日	月	曜日	年	意味
0	0	?	*	MON-FRI	*	毎週月曜日から金曜日の午前 0 時 (UTC+0) にワークフローを実行します。
0	2	*	*	?	*	ワークフローを毎日午前 2 時 (UTC+0) に実行します。
15	22	*	*	?	*	ワークフローを毎日午後 10:15 (UTC+0) に実行します。
0/30	22-2	?	*	SAT-SUN	*	ワークフローは、土曜日から日曜日の開始日の午後 10 時から翌日の午前 2 時 (UTC+0) の間、30 分ごとに実行されます。
45	13	L	*	?	2023-2027	ワークフローは、2023 年から 2027 年までの月の最終日の午後 1 時 45 分 (UTC+0) に実行されます。

で cron 式を指定するときは CodeCatalyst、次のガイドラインに従ってください。

SCHEDULE トリガーごとに 1 つの cron 式を指定します。
YAML エディタで cron 式を二重引用符 (") で囲みます。
協定世界時 () で時刻を指定しますUTC。その他のタイムゾーンはサポートされていません。
実行の合間に 30 分以上を設定します。より高速なケイデンスはサポートされていません。
を指定する days-of-month または days-of-week フィールド。両方ではありません。いずれかのフィールドに値またはアスタリスク (*) を指定する場合は、もう一方のフィールドに疑問符 (?) を使用する必要があります。アスタリスクは「all」、疑問符は「any」を意味します。

cron 式のその他の例と、?、、 *などのワイルドカードに関する情報についてはL、「Amazon EventBridge ユーザーガイド」の「Cron 式のリファレンス」を参照してください。 EventBridge との Cron 式はまったく同じように CodeCatalyst 動作します。

スケジュールトリガーの例については、「」を参照してください例: ワークフローのトリガー。

ブランチとブランチパターン

(オプション)

ワークフロー実行を開始するタイミングを知るために、トリガーがモニタリングするソースリポジトリ内のブランチを指定します。正規表現パターンを使用してブランチ名を定義できます。例えば、 main.*を使用して、で始まるすべてのブランチを照合しますmain。

指定するブランチは、トリガータイプによって異なります。

プッシュトリガーでは、にプッシュするブランチ、つまり送信先ブランチを指定します。一致するブランチ内のファイルを使用して、一致するブランチごとに 1 つのワークフロー実行が開始されます。

例: main.*、mainline
プルリクエストトリガーでは、にプッシュするブランチ、つまり送信先ブランチを指定します。ワークフロー定義ファイルとソースブランチ内のソースファイル (一致したブランチではない) を使用して、一致したブランチごとに 1 回のワークフロー実行が開始されます。

例: main.*、mainline、 v1\-.* ( で始まるブランチに一致v1-）
スケジュールトリガーには、スケジュールされた実行で使用するファイルを含むブランチを指定します。一致するブランチごとに 1 つのワークフロー実行が開始され、一致するブランチのワークフロー定義ファイルとソースファイルが使用されます。

例: main.*、version\-1\.0

注記

ブランチを指定しない場合、トリガーはソースリポジトリ内のすべてのブランチをモニタリングし、ワークフロー定義ファイルとソースファイルを使用してワークフロー実行を開始します。

プッシュ先のブランチ (プッシュトリガーの場合）。詳細については、「例: シンプルなコードプッシュトリガー」を参照してください。
プル元のブランチ (プルリクエストトリガーの場合）。詳細については、「例: シンプルなプルリクエストトリガー」を参照してください。
すべてのブランチ (スケジュールトリガー用）。ソースリポジトリのブランチごとに 1 回のワークフロー実行が開始されます。詳細については、「例: シンプルなスケジュールトリガー」を参照してください。

ブランチとトリガーの詳細については、「」を参照してくださいトリガーとブランチの使用ガイドライン。

その他の例については、「例: ワークフローのトリガー」を参照してください。

変更されたファイル

このフィールドは、プッシュまたはプルリクエストのトリガータイプを選択した場合にのみ表示されます。

ワークフロー実行を開始するタイミングを知るために、トリガーがモニタリングするソースリポジトリ内のファイルまたはフォルダを指定します。正規表現を使用して、ファイル名またはパスを一致させることができます。

例については、「例: ワークフローのトリガー」を参照してください。

（オプション) 検証を選択して、コミットする前にワークフローのYAMLコードを検証します。
コミット を選択し、コミットメッセージを入力し、もう一度コミット を選択します。

YAML

トリガーを追加するには (YAML エディタ）

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。
プロジェクトを選択します。
ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。
ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名またはステータスでフィルタリングすることもできます。
[編集] を選択します。
を選択しますYAML。
次の例をガイドとして使用して、Triggersセクションと基盤となるプロパティを追加します。詳細については、ワークフローYAML定義の「Triggers」を参照してください。

コードプッシュトリガーは次のようになります。
```
Triggers:
  - Type: PUSH
    Branches:
      - main
```
プルリクエストトリガーは次のようになります。
```
Triggers:
  - Type: PULLREQUEST
    Branches:
      - main.*
    Events: 
      - OPEN
      - REVISION
      - CLOSED
```
スケジュールトリガーは次のようになります。
```
Triggers:
  - Type: SCHEDULE
    Branches:
      - main.*
    # Run the workflow at 1:15 am (UTC+0) every Friday until the end of 2023
    Expression: "15 1 ? * FRI 2022-2023"
```
Expression プロパティで使用できる cron 式のその他の例については、「」を参照してくださいExpression。

プッシュ、プルリクエスト、スケジュールトリガーのその他の例については、「」を参照してください例: ワークフローのトリガー。
（オプション) 検証を選択して、コミットする前にワークフローのYAMLコードを検証します。
コミット を選択し、コミットメッセージを入力し、もう一度コミット を選択します。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

トリガーとブランチの使用ガイドライン

手動のみのトリガーの設定