パイプラインをトリガーするイベントの指定

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022

パイプライン トリガーは、実行するタイミングをパイプラインに指示します。 トリガーは、スケジュールに基づいて、またはプル要求の作成などのイベントに応答してパイプラインを実行するように構成できます。 Azure Pipelinesでは、次の種類のトリガーがサポートされています。

• 継続的インテグレーション トリガー (CI トリガー) は、コードをブランチにプッシュするときにパイプラインを実行します。
• プル要求トリガー (PR トリガー) は、開いている PR のソース ブランチに PR またはプッシュ コードを発生させるとパイプラインを実行します。 GitHub リポジトリでは、開いている pull request にコメントを追加するときにパイプラインを実行するコメント トリガーがサポートされます。
• スケジュールされたトリガーは、定義済みのスケジュールでパイプラインを実行します。
• パイプライン完了トリガーは、別のパイプラインが完了したときにパイプラインを実行します。

この記事では、 YAML パイプライン トリガーと クラシック ビルド パイプライン トリガーの概要について説明します。 クラシック リリース パイプラインには、 前の一覧で説明した同様のバージョンのトリガーがあります。 詳細については、「 クラシック リリース パイプライン トリガー」を参照してください。

CI のトリガー

trigger:
- main

trigger: none

PR トリガー

pr:
- main

pr: none

コメントのトリガー

コメント トリガーを使用すると、コントリビューターが /azp run のようなプル リクエスト コマンドを含むプル リクエスト コメントを作成したときに、パイプラインが実行されるように構成できます。 コメント トリガーは、GitHub リポジトリでのみサポートされます。 詳細については、「GitHub リポジトリのコメント トリガーを参照してください。

スケジュールされたトリガー

# YAML file in the main branch
schedules:
- cron: '0 0 * * *'
  displayName: Daily midnight build
  branches:
    include:
    - main

パイプラインの完了時トリガー

YAML パイプラインのパイプライン トリガーとクラシック ビルド パイプラインのビルド完了トリガーを使用すると、別のパイプラインの完了時に 1 つのパイプラインをトリガーできます。

resources:
  pipelines:
  - pipeline: sourcePipelineResource # Label for this pipeline resource; used when referring to it elsewhere in the pipeline.
    source: source-pipeline # The name of the pipeline referenced by this pipeline resource.
    project: FabrikamProject # Required only if the source pipeline is in another project
    trigger: true # Run this pipeline when any run of source-pipeline completes

YAML パイプラインでのトリガーに関するブランチの考慮事項

YAML パイプラインでは、異なるブランチで異なるバージョンのパイプラインを保持できが、これは評価されるパイプラインのトリガーのバージョンと、実行するパイプラインのバージョンに影響を与える可能性があります。

YAML パイプラインのリソース トリガー

リポジトリ リソース トリガーを使用すると、 repositories リソースとして定義されたリポジトリに変更が反映されたときにパイプラインを開始できます。 リソースに対して CI スタイルのtrigger フィルターを構成して、外部の Azure Repos Git、GitHub、GitHub Enterprise、または Bitbucket Cloud リポジトリ内のコミットまたは PR が現在のパイプラインの実行を開始できるようにします。

Azure Pipelinesでは、他のリソースの種類でも同様のイベント ドリブン トリガーがサポートされます。

• pipelines: アップストリーム CI パイプラインの完了時 (オプションのブランチ、タグ、ステージ フィルターを使用)
• builds: Jenkins などの外部 CI システムからの新しい成果物
• containers: Azure Container Registryの新しいイメージ タグの場合
• packages: 新しい NuGet または npm GitHub パッケージ バージョンの場合
• webhooks: GitHub、Nexus、Artifactory などの外部サービスから受信 Webhook サービス接続経由の任意のイベントに対して

詳細については、「 YAML パイプラインのリソース」を参照してください。

YAML パイプライン用の汎用 Webhook ベースのトリガー

YAML パイプラインでの Webhook トリガーのサポートにより、Webhook を介して外部サービス (GitHub、GitHub Enterprise、Nexus、Artifactory など) からイベントをサブスクライブし、パイプラインを自動的にトリガーできます。 この機能により、パイプライン、コンテナー、ビルド、パッケージなどの組み込みリソースを超えて、自動化されたトリガーが拡張されます。 パイプラインの自動化は、任意の外部サービスと統合できます。

この機能を使用するには、YAML パイプラインの resources.webhooks の下にwebhook リソースを定義し、イベントをサブスクライブする受信 Webhook サービス接続をポイントします。 JSON ペイロードに対してフィルターを追加して、各パイプラインの実行時に微調整し、ジョブの変数としてペイロード値にアクセスできます。

resources:
  webhooks:
    - webhook: MyWebhookTrigger          ### Webhook alias
      connection: MyWebhookConnection    ### Incoming webhook service connection
      filters:
        - path: repositoryName      ### JSON path in the payload
          value: maven-releases     ### Expected value in the path provided
        - path: action
          value: CREATED
steps:
- task: PowerShell@2
  inputs:
    targetType: 'inline'
    ### JSON payload data is available in the form of ${{ parameters.<WebhookAlias>.<JSONPath>}}
    script: |
      Write-Host ${{ parameters.MyWebhookTrigger.repositoryName}}
      Write-Host ${{ parameters.MyWebhookTrigger.component.group}}

詳細については、YAML パイプラインと resources.webhooks.webhook 定義の汎用 Webhook ベースのトリガーに関するページを参照してください。

クラシック リリース パイプライン

継続的デプロイ トリガーは、クラシック ビルドまたは YAML パイプラインの完了後にクラシック リリースを開始するのに役立ちます。

スケジュールされたリリース トリガーを使用すると、スケジュールに従ってリリース パイプラインを実行できます。

pull request リリース トリガーは、クラシック リリースを使用して pull request を直接デプロイするために使用されます。

クラシック リリースのステージ トリガーは、クラシック リリースの各ステージのトリガー方法を構成するために使用されます。