schedules.cron の定義

スケジュールされたトリガーは、ブランチを構築するスケジュールを指定します。

schedules:
- cron: string # Required as first property. Cron syntax defining a schedule in UTC time.
  displayName: string # Optional friendly name given to a specific schedule.
  branches: # Branch names to include or exclude for triggering a run.
    include: [ string ] # List of items to include.
    exclude: [ string ] # List of items to exclude.
  batch: boolean # Whether to run the pipeline if the previously scheduled run is in-progress; the default is false.
  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 # Required as first property. Cron syntax defining a schedule in UTC time.
  displayName: string # Optional friendly name given to a specific schedule.
  branches: # Branch names to include or exclude for triggering a run.
    include: [ string ] # List of items to include.
    exclude: [ string ] # List of items to exclude.
  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.

この定義を参照する定義: スケジュール

cron 文字列。 最初のプロパティとして必要です。
スケジュールを UTC 時刻で定義する Cron 構文を します。

displayName 文字列。
特定のスケジュールに指定された省略可能なフレンドリ名です。

includeExcludeFiltersを します。
実行をトリガーするために含めるか除外するブランチ名。

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

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

ブールを alwaysします。
パイプラインを常に実行するか、前回成功したスケジュールされた実行以降にソース コードが変更された場合にのみ実行するかを指定します。既定値は false です。

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')

その他の例については、次の 例 セクションを参照してください。

スケジュールされたトリガーによってスケジュールされたかどうかに基づいてステージまたはジョブを条件付きで実行するには、条件で Build.CronSchedule.DisplayName 変数を使用します。 この例では、stage1Daily midnight build スケジュールによってパイプラインがトリガーされた場合にのみ実行され、job3Weekly Sunday build スケジュールによってパイプラインがトリガーされた場合にのみ実行されます。

stages:
- 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')
  jobs:
  - job: job1
    steps:
    - script: echo Hello from Stage 1 Job 1

- stage: stage2
  dependsOn: [] # Indicate this stage does not depend on the previous stage
  jobs:
  - job: job2
    steps:
    - script: echo Hello from Stage 2 Job 2
  - job: job3 
    # Run this job only when the pipeline is triggered by the 
    # "Weekly Sunday build" cron schedule
    condition: eq(variables['Build.CronSchedule.DisplayName'], 'Weekly Sunday build')
    steps:
    - script: echo Hello from Stage 2 Job 3