ステージ、依存関係、条件の追加

パイプライン ジョブをステージ内で整理できます。 ステージはパイプラインの主要な部分であり、このアプリの構築、これらのテストの実行、実稼働前のデプロイは、ステージの適切な例です。 これらはパイプライン内の論理境界であり、パイプラインを一時停止してさまざまなチェックを実行できます。

明示的に定義しない場合でも、すべてのパイプラインには少なくとも 1 つのステージがあります。 ステージを依存関係グラフに配置して、あるステージが別のステージの前に実行されるようにすることもできます。 ステージには 256 ジョブという制限があります。

最も単純な状況では、パイプラインに論理境界は必要ありません。 その場合、stage キーワードを明示的に使用する必要はありません。 YAML ファイルでジョブを直接指定できます。

# this has one implicit stage and one implicit job
pool:
  vmImage: 'ubuntu-latest'
steps:
- bash: echo "Hello world"

# this pipeline has one implicit stage
jobs:
- job: A
  steps:
  - bash: echo "A"

- job: B
  steps:
  - bash: echo "B"

パイプラインを複数のステージに編成する場合は、stages キーワードを使用します。

stages:
- stage: A
  jobs:
  - job: A1
  - job: A2

- stage: B
  jobs:
  - job: B1
  - job: B2

ステージ レベルで pool を指定することを選択した場合、ステージ レベルで指定されていない限り、そのステージで定義されているすべてのジョブは、そのプールを使用します。

stages:
- stage: A
  pool: StageAPool
  jobs:
  - job: A1 # will run on "StageAPool" pool based on the pool defined on the stage
  - job: A2 # will run on "JobPool" pool
    pool: JobPool

ステージを指定する完全な構文:

stages:
- stage: string  # name of the stage, A-Z, a-z, 0-9, and underscore
  displayName: string  # friendly name to display in the UI
  dependsOn: string | [ string ]
  condition: string
  pool: string | pool
  variables: { string: string } | [ variable | variableReference ] 
  jobs: [ job | templateReference]

パイプラインで複数のステージを定義すると、既定では、YAML ファイルで定義した順序で順番に実行されます。 ここでの例外は、依存関係を追加する場合です。 依存関係を使用すると、ステージは、dependsOn 要件の順序で実行されます。

パイプラインには、依存関係のないステージが少なくとも 1 つ含まれている必要があります。

複数のステージとその依存関係を定義するための構文は次のとおりです。

stages:
- stage: string
  dependsOn: string
  condition: string

順番に実行されるステージの例:

# if you do not use a dependsOn keyword, stages run in the order they are defined
stages:
- stage: QA
  jobs:
  - job:
    ...

- stage: Prod
  jobs:
  - job:
    ...

並列で実行されるステージの例:

stages:
- stage: FunctionalTest
  jobs:
  - job:
    ...

- stage: AcceptanceTest
  dependsOn: []    # this removes the implicit dependency on previous stage and causes this to run in parallel
  jobs:
  - job:
    ...

ファンアウトとファンインの例:

stages:
- stage: Test

- stage: DeployUS1
  dependsOn: Test    # this stage runs after Test

- stage: DeployUS2
  dependsOn: Test    # this stage runs in parallel with DeployUS1, after Test

- stage: DeployEurope
  dependsOn:         # this stage runs after DeployUS1 and DeployUS2
  - DeployUS1
  - DeployUS2

前のステージの実行状態に基づいてステージを実行する例:

stages:
- stage: A

# stage B runs if A fails
- stage: B
  condition: failed()

# stage C runs if B succeeds
- stage: C
  dependsOn:
  - A
  - B
  condition: succeeded('B')

カスタム条件の使用例:

stages:
- stage: A

- stage: B
  condition: and(succeeded(), eq(variables['build.sourceBranch'], 'refs/heads/main'))

YAML パイプラインでは、キュー ポリシーはサポートされていません。 パイプラインの実行は他の実行からは独立しており、認識できません。 言い換えると、2 回の連続するコミットによって 2 つのパイプラインがトリガーされる可能性があり、両方とも互いを待たずに同じ一連のステージを実行します。 このことが重要である場合は、Microsoft がキュー ポリシーを YAML パイプラインに実装するまでは、手動による承認を使用して実行の順序を手動で順序付けして制御することをお勧めします。

承認チェックを使用することにより、ステージを実行するタイミングを手動で制御できます。 これは一般的に、運用環境へのデプロイを制御するために使用されます。 チェックは、パイプライン内のステージがリソースを使用できるかどうか、およびいつ使用できるかを制御するためにリソース所有者が使用できるメカニズムです。 環境などのリソースの所有者は、そのリソースを消費するステージを開始する前に満たす必要があるチェックを定義できます。

現在、環境では手動承認チェックがサポートされています。 詳細については、承認に関するページを参照してください。

このバージョンの Azure DevOps Server では、YAML パイプラインでの承認はまだサポートされていません。