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

スケジュールされたトリガーは、 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 or pipeline settings 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 or pipeline settings 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 です。 GitHub Copilot から AI の支援を受けて、cron 式を作成できます。
• 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

次に、new-featureという名前のmainに基づいて新しいブランチが作成されます。 新しいブランチの 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

ここで、mainに基づいて release という名前のブランチが作成され、releaseが main ブランチの YAML ファイル内のブランチ フィルターに追加され、新しく作成された 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

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

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

batch プロパティは、以前にスケジュールされた実行が進行中の場合にパイプラインを実行するかどうかを構成します。 batchがtrueされている場合、前のパイプラインの実行がまだ進行中の場合、スケジュールにより新しいパイプラインの実行は開始されません。 既定値は falseです。

batch プロパティは、always プロパティの設定の影響を受けます。 alwaysがtrueされると、batchがtrueされ、実行中の実行がある場合でも、cron スケジュールに従ってパイプラインが実行されます。

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 の例を参照してください。

次の例では、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

最初のスケジュール (毎日午前 0 時のビルド) は、毎日午前 0 時にパイプラインを実行しますが、releases/ancient/*の下のブランチを除く、mainとすべてのreleases/*ブランチについて、スケジュールされた最後の正常な実行以降にコードが変更された場合にのみ実行されます。

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

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

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

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

  

• 毎週月曜日から金曜日の午前 3:00 (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 式」を参照してください。

GitHub Copilot を使用して cron 式を作成する

GitHub Copilot から AI の支援を受けて cron 式を構築したり、既存の cron 式をローカル タイム ゾーンから UTC に変換したりできます。

Azure Pipelines cron スケジュールは UTC で定義されているため、 毎週月曜日、水曜日、金曜日の午後 6 時にビルド などのスケジュールを cron 構文を使用して作成し、ローカル タイム ゾーンから UTC に変換する必要があります。

次のプロンプトをカスタマイズして cron 式を作成するか、式の作成に使用したタイム ゾーンから cron 式を UTC に変換します。

次の例では、Copilot は毎週月曜日、水曜日、金曜日の午後 6 時 (東部標準時) に構築する UTC cron スケジュールを作成するように求められます。

Build a UTC cron expression for Monday, Wednesday, and Friday at 6:00 PM Eastern Standard Time

ローカル タイム ゾーンに cron 式が既にある場合は、Copilot に UTC に変換するように依頼できます。 この例では、毎週月曜日、水曜日、金曜日の午後 6:00 (0 18 * * Mon,Wed,Fri) 東部標準時にビルドする cron スケジュールが UTC に変換されます。

Convert the following cron expression from Eastern Standard Time to UTC: 0 18 * * Mon,Wed,Fri

cron 式を UTC に変換するには、式の曜日を変更する必要がある場合があります。 次の例では、月曜日から金曜日の午前 12 時 30 分に中央ヨーロッパ標準時にビルドする UTC cron スケジュールを作成するように求められます。 中央ヨーロッパ標準時は UTC より前なので、結果の式は月曜日の早朝ではなく日曜日の夜遅くに開始され、木曜日に終了します。

Build a UTC cron expression for Monday through Friday at 12:30 AM Central European Standard Time

Copilot によって生成された cron 式に関する追加の詳細を取得するには、プロンプトで生成された cron 式の説明を提供するように Copilot に依頼できます。

Build a UTC cron expression for Monday through Friday at 12:30 AM Central European Standard Time and explain the different parts of the cron expression

Copilot では AI を利用しているため、想定外のことや間違いが起こる可能性があります。 詳細については、 Copilot の一般的な使用に関する FAQ を参照してください。

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

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

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

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

[スケジュールされた実行] ウィンドウには、Azure DevOps ポータルの参照に使用したコンピューターで設定されたローカル タイム ゾーンに変換された時刻が表示されます。 次の使用例は、EST タイム ゾーンで撮影されたスクリーンショットを表示します。

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

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

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

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

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