トリガーの例

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

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

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

このトリガーがアクティブ化されると、 はプッシュ先のブランチ (つまり、送信先ブランチ) 内のファイルを使用してワークフロー実行 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\/.*