パイプラインのスケジュールを構成する

スケジュールされたトリガーは、Cron 構文を使って定義されたスケジュールで実行するようにパイプラインを構成します。

schedules:
- cron: string # cron syntax defining a schedule
  displayName: string # friendly name given to a specific schedule
  branches:
    include: [ string ] # which branches the schedule applies to
    exclude: [ string ] # which branches to exclude from the schedule
  always: boolean # whether to always run the pipeline or only if there have been source code changes since the last successful scheduled run. The default is false.

schedules:
- cron: string # cron syntax defining a schedule
  displayName: string # friendly name given to a specific schedule
  branches:
    include: [ string ] # which branches the schedule applies to
    exclude: [ string ] # which branches to exclude from the schedule
  always: boolean # whether to always run the pipeline or only if there have been source code changes since the last successful scheduled run. The default is false.
  batch: boolean # Whether to run the pipeline if the previously scheduled run is in-progress; the default is false.
  # batch is available in Azure DevOps Server 2022.1 and higher

YAML のスケジュールされたパイプラインには、次の制約があります。

• Cron スケジュールのタイム ゾーンは UTC です。
• branches に対して include 句を指定せずに exclude 句を指定すると、include 句で * を指定した場合と同じなります。
• スケジュールを指定するときは、パイプライン変数を使用できません。
• YAML ファイルでテンプレートを使用する場合は、テンプレート ファイルではなくメイン YAML ファイルでスケジュールを指定する必要があります。

スケジュールされたトリガーに関するブランチの考慮事項

スケジュールされたトリガーは、次のイベントが発生したときにブランチについて評価されます。

• パイプラインが作成されたとき。
• プッシュから、またはパイプライン エディターで編集することによって、パイプラインの YAML ファイルが更新されたとき。
• パイプラインの YAML ファイル パスが、異なる YAML ファイルを参照するように更新されたとき。 この変更では既定のブランチのみが更新されるため、更新された YAML ファイルでの既定のブランチのスケジュールのみが取得されます。 その後、他のブランチが既定のブランチをマージした場合 (例: git pull origin main)、新しく参照されるようになった YAML ファイルからのスケジュールされたトリガーが、そのブランチに対して評価されます。
• 新しいブランチが作成されたとき。

ブランチでこれらのイベントのいずれかが発生すると、そのブランチの YAML ファイルに含まれるスケジュールされたトリガーのブランチ フィルターとそのブランチが一致する場合、そのブランチに対するスケジュールされた実行が追加されます。

たとえば、次のスケジュールでパイプラインが作成され、このバージョンの YAML ファイルが main ブランチにチェックインされます。 このスケジュールでは、main ブランチが毎日ビルドされます。

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

次に、main に基づいて new-feature という名前の新しいブランチが作成されます。 新しいブランチの YAML ファイルからスケジュールされたトリガーが読み取られ、new-feature ブランチと一致しないため、スケジュールされたビルドの変更は行われず、new-feature ブランチはスケジュールされたトリガーを使ってビルドされません。

new-feature が branches リストに追加され、この変更が new-feature ブランチにプッシュされた場合は、YAML ファイルが読み取られて、new-feature がブランチ リストに含まれるようになったので、new-feature ブランチに対してスケジュールされたビルドが追加されます。

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

ここで、release という名前のブランチが main に基づいて作成された後、main ブランチの YAML ファイルのブランチ フィルターには release が追加されますが、新しく作成された release ブランチには追加されないものとします。

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

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

main ブランチのブランチ フィルターには release が追加されましたが、release ブランチのブランチ フィルターには追加されなかったため、release ブランチはそのスケジュールではビルドされません。 リリース ブランチの YAML ファイルのブランチ フィルターに release ブランチが追加された場合にのみ、スケジュールされたビルドがスケジューラに追加されます。

スケジュールされたトリガーに関するバッチの考慮事項

batch プロパティは、以前にスケジュールされた実行が進行中の場合にパイプラインを実行するかどうかを構成します。デフォルトは false です。 これは、パイプライン リポジトリのバージョンに関係なく適用されます。

always と batch の相互作用についての説明を以下の表に示します。

Build.CronSchedule.DisplayName 変数

cron でスケジュールされたトリガーが原因でパイプラインが実行されている場合、事前定義された Build.CronSchedule.DisplayName 変数には、パイプライン実行をトリガーした cron スケジュールの displayName が含まれます。

YAML パイプラインには複数の cron スケジュールが含まれる場合があるため、状況によっては、どの cron スケジュールを実行するかによって異なるステージまたはジョブをパイプラインで実行することが必要になります。 たとえば、夜間ビルドと毎週のビルドがあり、特定のステージについては夜間ビルド中にのみ実行したいような場合、 ジョブ条件またはステージ条件の中で Build.CronSchedule.DisplayName 変数を使用すると、そのジョブまたはステージを実行するかどうかを決定できます。

- stage: stage1
  # Run this stage only when the pipeline is triggered by the 
  # "Daily midnight build" cron schedule
  condition: eq(variables['Build.CronSchedule.DisplayName'], 'Daily midnight build')

その他の例については、schedules.cron の例を参照してください。

スケジュールされたビルドは、Azure DevOps Server 2019 の YAML 構文ではサポートされていません。 YAML ビルド パイプラインを作成した後で、パイプラインの設定を使って、スケジュールされたトリガーを指定できます。

次の例では、2 つのスケジュールを定義します。

schedules:
- cron: '0 0 * * *'
  displayName: Daily midnight build
  branches:
    include:
    - main
    - releases/*
    exclude:
    - releases/ancient/*
- cron: '0 12 * * 0'
  displayName: Weekly Sunday build
  branches:
    include:
    - releases/*
  always: true

1 つ目のスケジュール Daily midnight build では、毎日午前 0 時にパイプラインが実行されますが、main とすべての releases/* ブランチについて、最後の正常なスケジュールされた実行以降にコードが変更された場合だけであり、releases/ancient/* の下のブランチは除外されます。

2 つ目のスケジュール Weekly Sunday build では、すべての releases/* ブランチについて、コードが前回の実行以降に変更されているかどうかに関係なく、日曜日の正午にパイプラインが実行されます。

その他の例については、「クラシック エディターからの移行」をご覧ください。

スケジュールされたビルドは、Azure DevOps Server 2019 の YAML 構文ではサポートされていません。 YAML ビルド パイプラインを作成した後で、パイプラインの設定を使って、スケジュールされたトリガーを指定できます。

この例では、クラシック エディターのスケジュールされたトリガーに 2 つのエントリがあり、次のビルドが生成されます。

• 毎週月曜日から金曜日の午前 3 時 (UTC + 5:30 タイム ゾーン) に、features/india/* ブランチ フィルター条件を満たすブランチをビルドします

  

• 毎週月曜日から金曜日の午前 3 時 (UTC - 5:00 タイム ゾーン) に、features/nc/* ブランチ フィルター条件を満たすブランチをビルドします

  

Azure Pipelines と Azure DevOps 2019 Server

この例では、クラシック エディターのスケジュールされたトリガーに 2 つのエントリがあり、次のビルドが生成されます。

• 毎週月曜日から金曜日の午前 3 時 (UTC) に、main と releases/* のブランチ フィルター条件を満たすブランチをビルドします

  

• 毎週日曜日の午前 3 時 (UTC) に、ソースまたはパイプラインが変更されていない場合でも、releases/lastversion ブランチをビルドします

  

Azure Pipelines のスケジュールされたトリガーの各 Cron 式は、次の順序で 5 つのエントリを含むスペース区切りの式です。 式は単一引用符 ' で囲まれています。

mm HH DD MM DW
 \  \  \  \  \__ Days of week
  \  \  \  \____ Months
   \  \  \______ Days
    \  \________ Hours
     \__________ Minutes

値は、次の形式で指定できます。

サポートされている形式について詳しくは、「Crontab 式」をご覧ください。

スケジュールされたビルドは、Azure DevOps Server 2019 の YAML 構文ではサポートされていません。 YAML ビルド パイプラインを作成した後で、パイプラインの設定を使って、スケジュールされたトリガーを指定できます。

パイプラインのパイプライン詳細ページのコンテキスト メニューから [スケジュールされた実行] を選ぶことで、今後のスケジュールされたビルドのプレビューを表示できます。

スケジュールされたトリガーを作成または更新した後、スケジュールされた実行 ビューを使用して検証できます。

この例では、次のスケジュールのスケジュールされた実行を表示します。

schedules:
- cron: '0 0 * * *'
  displayName: Daily midnight build
  branches:
    include:
    - main

[スケジュールされた実行] ウィンドウには、Azure DevOps ポータルの参照に使われるコンピューターで設定されているローカル タイム ゾーンに変換された日時が表示されます。 この例で示すスクリーンショットは、EST タイム ゾーンで取得されたものです。

スケジュールされたビルドは、Azure DevOps Server 2019 の YAML 構文ではサポートされていません。 YAML ビルド パイプラインを作成した後で、パイプラインの設定を使って、スケジュールされたトリガーを指定できます。

パイプラインのパイプライン詳細ページのコンテキスト メニューから [スケジュールされた実行] を選ぶことで、今後のスケジュールされたビルドのプレビューを表示できます。

スケジュールされたトリガーを作成または更新したら、このビューを使ってトリガーを確認できます。

クラシック スケジュールによるパイプラインには [スケジュールされた実行] ビューはありませんが、パイプラインのクラシック スケジュール エディターでパイプラインのスケジュールを表示できます。

コードの変更がない場合でもパイプラインを強制的に実行するには、always キーワードを使用できます。

schedules:
- cron: ...
  ...
  always: true

このバージョンの Azure DevOps Server の YAML 構文では、スケジュールされたビルドはサポートされていません。 YAML ビルド パイプラインを作成した後で、パイプラインの設定を使って、スケジュールされたトリガーを指定できます。

前回のビルド以降に変更があった場合にのみビルドするよう、スケジュールされたパイプラインを構成するには、[ソースまたはパイプラインが変更された場合にのみビルドをスケジュール] をオンにします。