例: シンプルなコードプッシュトリガー例: シンプルな「メインにプッシュ」トリガー例: シンプルなプルリクエストトリガー例: シンプルなスケジュールトリガー例: スケジュールとブランチを含むトリガー例: スケジュール、プッシュ、ブランチを含むトリガー例: プルとブランチを含むトリガー例: プル、ブランチ、およびCLOSED「」イベントを含むトリガー例: プッシュ、ブランチ、ファイルを含むトリガー例: 手動トリガー例: CI/CD マルチワークフロー設定のトリガー

例: ワークフローのトリガー

次の例は、Amazon CodeCatalyst ワークフロー定義ファイルにさまざまなタイプのトリガーを追加する方法を示しています。

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

例: シンプルなコードプッシュトリガー

次の例は、ソースリポジトリ内のブランチにコードがプッシュされるたびにワークフロー実行を開始するトリガーを示しています。

このトリガーがアクティブ化されると、はプッシュ先のブランチ (つまり、送信先ブランチ) 内のファイルを使用してワークフロー実行 CodeCatalyst を開始します。

例えば、コミットをにプッシュするとmain、はの workfow 定義ファイルとその他のソースファイルを使用してワークフロー実行 CodeCatalyst を開始しますmain。

別の例として、コミットをにプッシュするとfeature-branch-123、はの workfow 定義ファイルと他のソースファイルを使用してワークフロー実行 CodeCatalyst を開始しますfeature-branch-123。


Triggers:
  - Type: PUSH

注記

にプッシュした場合にのみワークフローの実行を開始する場合はmain、「」を参照してください例: シンプルな「メインにプッシュ」トリガー。

例: シンプルな「メインにプッシュ」トリガー

次の例は、ソースリポジトリmain内のブランチ、およびmainブランチにのみコードがプッシュされるたびにワークフロー実行を開始するトリガーを示しています。


Triggers:
  - Type: PUSH
    Branches:
      - main

例: シンプルなプルリクエストトリガー

次の例は、ソースリポジトリでプルリクエストが作成または改訂されるたびにワークフロー実行を開始するトリガーを示しています。

このトリガーがアクティブ化されると、は、ワークフロー定義ファイルと、プル元のブランチ (ソースブランチ) 内の他のソースファイルを使用してワークフロー実行 CodeCatalyst を開始します。

例えば、というソースブランチfeature-123とという宛先ブランチを使用してプルリクエストを作成するとmain、はの workfow 定義ファイルとその他のソースファイルを使用してワークフロー実行 CodeCatalyst を開始しますfeature-123。


Triggers:
  - Type: PULLREQUEST
    Events:
      - OPEN
      - REVISION

例: シンプルなスケジュールトリガー

次の例は、毎週月曜日から金曜日の午前 0 時 (UTC+0) にワークフロー実行を開始するトリガーを示しています。

このトリガーがアクティブ化されると、は、このトリガーを持つワークフロー定義ファイルを含むソースリポジトリ内のブランチごとに 1 つのワークフロー実行 CodeCatalyst を開始します。

例えば、ソースリポジトリに 3 つのブランチがある場合、、feature-123、、mainrelease-v1、およびこれらの各ブランチに、次のトリガーを持つワークフロー定義ファイルが含まれている場合、はのファイルを使用して 3 つのワークフロー実行 CodeCatalyst を開始します。1 つはのファイルを使用しmain、もう 1 つはのファイルrelease-v1を使用しますfeature-123。


Triggers:
  - Type: SCHEDULE
    Expression: "0 0 ? * MON-FRI *"

Expression プロパティで使用できる cron 式のその他の例については、「」を参照してくださいExpression。

例: スケジュールとブランチを含むトリガー

次の例は、毎日午後 6:15 (UTC+0) にワークフロー実行を開始するトリガーを示しています。

このトリガーがアクティブ化されると、はmainブランチ内のファイルを使用してワークフロー実行 CodeCatalyst を開始し、で始まるブランチごとに追加の実行を開始しますrelease-。

例えば、ソースリポジトリbugfix-2に main、、release-v1、 bugfix-1という名前のブランチがある場合、は 2 つのワークフロー実行 CodeCatalyst を開始します。1 つはのファイルを使用しmain、もう 1 つはのファイルを使用しますrelease-v1。bugfix-1 ブランチと bugfix-1ブランチのワークフロー実行は開始されません。


Triggers:
  - Type: SCHEDULE
    Expression: "15 18 * * ? *"
    Branches:
      - main
      - release\-.*

Expression プロパティで使用できる cron 式のその他の例については、「」を参照してくださいExpression。

例: スケジュール、プッシュ、ブランチを含むトリガー

次の例は、毎日午前 0 時 (UTC+0) に、コードがmainブランチにプッシュされるたびにワークフロー実行を開始するトリガーを示しています。

この例では、以下のようになっています。

ワークフロー実行は毎日午前 0 時に開始されます。ワークフロー実行では、ワークフロー定義ファイルとmainブランチ内の他のソースファイルを使用します。
ワークフロー実行は、コミットをmainブランチにプッシュするたびに開始されます。ワークフロー実行では、ワークフロー定義ファイルと、送信先ブランチ () 内の他のソースファイルを使用しますmain。


Triggers:
  - Type: SCHEDULE
    Expression: "0 0 * * ? *"
    Branches:
      - main
  - Type: PUSH
    Branches: 
      - main

Expression プロパティで使用できる cron 式のその他の例については、「」を参照してくださいExpression。

例: プルとブランチを含むトリガー

次の例は、誰かがという送信先ブランチでプルリクエストを開くか変更するたびにワークフロー実行を開始するトリガーを示していますmain。Triggers 設定で指定されたブランチはですがmain、ワークフローの実行では、ソースブランチ ( からプルするブランチ) のワークフロー定義ファイルとその他のソースファイルが使用されます。


Triggers:      
  - Type: PULLREQUEST
    Branches:
      - main
    Events:
      - OPEN
      - REVISION

例: プル、ブランチ、およびCLOSED「」イベントを含むトリガー

次の例は、で始まるブランチでプルリクエストがクローズされるたびにワークフロー実行を開始するトリガーを示していますmain。

この例では、以下のようになっています。

で始まる送信先ブランチでプルリクエストを閉じるとmain、ワークフロー実行は、ワークフロー定義ファイルと (現在は閉じている) 送信元ブランチ内の他のソースファイルを使用して自動的に開始されます。
プルリクエストがマージされた後にブランチを自動的に削除するようにソースリポジトリを設定した場合、これらのブランチは CLOSED状態になることはありません。つまり、マージされたブランチはプルリクエストCLOSEDトリガーをアクティブ化しません。このシナリオでCLOSEDトリガーをアクティブ化する唯一の方法は、プルリクエストをマージせずに閉じることです。


Triggers:     
  - Type: PULLREQUEST
    Branches:
      - main.*               
    Events:
      - CLOSED

例: プッシュ、ブランチ、ファイルを含むトリガー

次の例は、mainブランチの filename.txt ファイルまたはsrcディレクトリ内のファイルに変更が加えられるたびにワークフロー実行を開始するトリガーを示しています。

このトリガーがアクティブ化されると、は、ワークフロー定義ファイルとmainブランチ内の他のソースファイルを使用してワークフロー実行 CodeCatalyst を開始します。


Triggers:
  - Type: PUSH
    Branches:
      - main
    FilesChanged:
      - filename.txt
      - src\/.*

例: 手動トリガー

手動トリガーを設定するには、ワークフロー定義ファイルから Triggersセクションを省略します。このセクションがないと、ユーザーはコンソールで実行ボタンを選択してワークフローを手動で開始するように強制されます CodeCatalyst。詳細については、「ワークフローの手動実行の開始」を参照してください。

例: CI/CD マルチワークフロー設定のトリガー

この例では、継続的インテグレーション (CI) と継続的デプロイ (CD) に個別の Amazon CodeCatalyst ワークフローを使用する場合にトリガーを設定する方法について説明します。

このシナリオでは、次の 2 つのワークフローを設定します。

CI ワークフロー – このワークフローは、プルリクエストが作成または改訂されたときにアプリケーションを構築してテストします。
CD ワークフロー — このワークフローは、プルリクエストがマージされたときにアプリケーションを構築してデプロイします。

CI ワークフローの定義ファイルは、次のようになります。


Triggers:      
  - Type: PULLREQUEST
    Branches:
      - main
    Events:
      - OPEN
      - REVISION
Actions:
  BuildAction:
    instructions-for-building-the-app
  TestAction:
    instructions-for-test-the-app

このTriggersコードは、ソフトウェアデベロッパーが機能ブランチをmainブランチにマージするよう求めるプルリクエストを作成する (または変更する) プルリクエストの更新たびに、ワークフロー実行を自動的に開始することを示します。は、ソースブランチ (機能ブランチ) のソースコードを使用してワークフロー実行 CodeCatalyst を開始します。

CD ワークフローの 定義ファイルは、次のようになります。


Triggers:      
  - Type: PUSH
    Branches:
      - main
Actions:
  BuildAction:
    instructions-for-building-the-app
  DeployAction:
    instructions-for-deploying-the-app

このTriggersコードは、へのマージmainが発生したときにワークフローを自動的に開始することを示します。は、mainブランチのソースコードを使用してワークフロー実行 CodeCatalyst を開始します。

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

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

ドキュメントの表記規則

トリガーを使用した自動実行の開始

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