パイプライン定義

パイプラインは、CI/CD のプロセスを記述する 1 つ以上のステージです。

実装

実装	説明
パイプライン: ステージ	ステージを含むパイプライン。
パイプライン: を拡張する	テンプレートを拡張するパイプライン。
パイプライン: ジョブ	ジョブと 1 つの暗黙的なステージを含むパイプライン。
パイプライン: ステップ	ステップと 1 つの暗黙的なジョブを含むパイプライン。

注釈

パイプラインは、CI/CD のプロセスを記述する 1 つ以上のステージです。 ステージは、パイプラインの主要な部門です。 "このアプリをビルドする"、"これらのテストを実行する"、"実稼働前環境にデプロイする" の各ステージはその良い例です。

ステージは 1 つ以上のジョブであり、同じコンピューターに割り当て可能な作業単位です。 ステージとジョブの両方を依存関係グラフに配置できます。 この例には、"このステージをそのステージの前に実行する" や "このジョブはそのジョブの出力に依存する" が含まれます。

ジョブは、順番に実行される一連のステップです。 ステップは、タスク、スクリプト、または外部テンプレートへの参照である場合があります。

この階層は、次のように、YAML ファイルの構造に反映されます。

- Pipeline
  - Stage A
    - Job 1
      - Step 1.1
      - Step 1.2
      - ...
    - Job 2
      - Step 2.1
      - Step 2.2
      - ...
  - Stage B
    - ...

単純なパイプラインでは、これらのレベルがすべて必要なわけではありません。 たとえば、単一ジョブ ビルドでは、ステップしかないため、ステージとジョブのコンテナーを省略できます。 また、この記事に示されている多くのオプションは必須ではなく、適切な既定値があるため、YAML 定義にそれらすべてを含める可能性は低いです。

ステージが 1 つの場合は、stages キーワードを省略し、キーワード ジョブを直接指定できます。

# ... other pipeline-level keywords
jobs: [ job | template ]

1 つのステージと 1 つのジョブがある場合は、stages キーワードと jobs キーワードを省略し、キーワード ステップを直接指定できます。

# ... other pipeline-level keywords
steps: [ script | bash | pwsh | powershell | checkout | task | template | ... ]

name プロパティを使用して、パイプラインの実行番号を構成します。 詳細については、「実行番号またはビルド番号構成する」を参照してください。

パイプライン: ステージ

ステージを含むパイプライン。

stages: [ stage | template ] # Required. Stages are groups of jobs that can run without human intervention.
pool: string | pool # Pool where jobs in this pipeline will run unless otherwise specified.
name: string # Pipeline run number.
appendCommitMessageToRunName: boolean # Append the commit message to the build number. The default is true.
trigger: none | trigger | [ string ] # Continuous integration triggers.
parameters: [ parameter ] # Pipeline template parameters.
pr: none | pr | [ string ] # Pull request triggers.
schedules: [ cron ] # Scheduled triggers.
resources: # Containers and repositories used in the build.
  builds: [ build ] # List of build resources referenced by the pipeline.
  containers: [ container ] # List of container images.
  pipelines: [ pipeline ] # List of pipeline resources.
  repositories: [ repository ] # List of repository resources.
  webhooks: [ webhook ] # List of webhooks.
  packages: [ package ] # List of package resources.
variables: variables | [ variable ] # Variables for this pipeline.
lockBehavior: sequential | runLatest # Behavior lock requests from this stage should exhibit in relation to other exclusive lock requests.

特性

stages ステージ. 必須。
ステージは、人間の介入なしに実行できるジョブのグループです。

プールを poolします。
特に指定しない限り、このパイプライン内のジョブが実行されるプールです。

name 文字列。
パイプラインの実行番号。

ブールを appendCommitMessageToRunNameします。
ビルド番号にコミット メッセージを追加します。 既定値は true です。

trigger トリガー。
継続的インテグレーション トリガーを します。

パラメーターparametersします。
パイプライン テンプレート パラメーターを します。

を prします。
pull request トリガーを します。

スケジュールを schedulesします。
スケジュールされたトリガーを します。

リソースresourcesします。
ビルドで使用されるコンテナーとリポジトリ。

variables 変数。
このパイプラインの変数を します。

lockBehavior 文字列。
このステージからの動作ロック要求は、他の排他的ロック要求に関連して示す必要があります。 sequential |runLatest。

例示

trigger:
- main

pool: 
  vmImage: ubuntu-latest

stages:
- stage: CI
  jobs:
  - job: CIWork
    steps:
    - script: "Do CI work"

- stage: Test
  jobs:
  - job: TestWork
    steps:
    - script: "Do test work"

パイプライン: 拡張

テンプレートを拡張するパイプライン。

extends: # Required. Extends a template.
  template: string # The template referenced by the pipeline to extend.
  parameters: # Parameters used in the extend.
pool: string | pool # Pool where jobs in this pipeline will run unless otherwise specified.
name: string # Pipeline run number.
appendCommitMessageToRunName: boolean # Append the commit message to the build number. The default is true.
trigger: none | trigger | [ string ] # Continuous integration triggers.
parameters: [ parameter ] # Pipeline template parameters.
pr: none | pr | [ string ] # Pull request triggers.
schedules: [ cron ] # Scheduled triggers.
resources: # Containers and repositories used in the build.
  builds: [ build ] # List of build resources referenced by the pipeline.
  containers: [ container ] # List of container images.
  pipelines: [ pipeline ] # List of pipeline resources.
  repositories: [ repository ] # List of repository resources.
  webhooks: [ webhook ] # List of webhooks.
  packages: [ package ] # List of package resources.
variables: variables | [ variable ] # Variables for this pipeline.
lockBehavior: sequential | runLatest # Behavior lock requests from this stage should exhibit in relation to other exclusive lock requests.

特性

extends 拡張されます。 必須。
テンプレートを拡張します。

プールを poolします。
特に指定しない限り、このパイプライン内のジョブが実行されるプールです。

name 文字列。
パイプラインの実行番号。

ブールを appendCommitMessageToRunNameします。
ビルド番号にコミット メッセージを追加します。 既定値は true です。

trigger トリガー。
継続的インテグレーション トリガーを します。

パラメーターparametersします。
パイプライン テンプレート パラメーターを します。

を prします。
pull request トリガーを します。

スケジュールを schedulesします。
スケジュールされたトリガーを します。

リソースresourcesします。
ビルドで使用されるコンテナーとリポジトリ。

variables 変数。
このパイプラインの変数を します。

lockBehavior 文字列。
このステージからの動作ロック要求は、他の排他的ロック要求に関連して示す必要があります。 sequential |runLatest。

パイプライン: ジョブ

ジョブと 1 つの暗黙的なステージを含むパイプライン。

jobs: [ job | deployment | template ] # Required. Jobs represent units of work which can be assigned to a single agent or server.
pool: string | pool # Pool where jobs in this pipeline will run unless otherwise specified.
name: string # Pipeline run number.
appendCommitMessageToRunName: boolean # Append the commit message to the build number. The default is true.
trigger: none | trigger | [ string ] # Continuous integration triggers.
parameters: [ parameter ] # Pipeline template parameters.
pr: none | pr | [ string ] # Pull request triggers.
schedules: [ cron ] # Scheduled triggers.
resources: # Containers and repositories used in the build.
  builds: [ build ] # List of build resources referenced by the pipeline.
  containers: [ container ] # List of container images.
  pipelines: [ pipeline ] # List of pipeline resources.
  repositories: [ repository ] # List of repository resources.
  webhooks: [ webhook ] # List of webhooks.
  packages: [ package ] # List of package resources.
variables: variables | [ variable ] # Variables for this pipeline.
lockBehavior: sequential | runLatest # Behavior lock requests from this stage should exhibit in relation to other exclusive lock requests.

特性

ジョブjobsします。 必須。
ジョブは、単一のエージェントまたはサーバーに割り当てることができる作業単位を表します。

プールを poolします。
特に指定しない限り、このパイプライン内のジョブが実行されるプールです。

name 文字列。
パイプラインの実行番号。

ブールを appendCommitMessageToRunNameします。
ビルド番号にコミット メッセージを追加します。 既定値は true です。

trigger トリガー。
継続的インテグレーション トリガーを します。

パラメーターparametersします。
パイプライン テンプレート パラメーターを します。

を prします。
pull request トリガーを します。

スケジュールを schedulesします。
スケジュールされたトリガーを します。

リソースresourcesします。
ビルドで使用されるコンテナーとリポジトリ。

variables 変数。
このパイプラインの変数を します。

lockBehavior 文字列。
このステージからの動作ロック要求は、他の排他的ロック要求に関連して示す必要があります。 sequential |runLatest。

例示

trigger:
- main

pool: 
  vmImage: ubuntu-latest

jobs:
- job: PreWork
  steps:
  - script: "Do pre-work"

- job: PostWork
  pool: windows-latest
  steps:
  - script: "Do post-work using a different hosted image"

パイプライン: 手順

ステップと 1 つの暗黙的なジョブを含むパイプライン。

steps: [ task | script | powershell | pwsh | bash | checkout | download | downloadBuild | getPackage | publish | template | reviewApp ] # Required. A list of steps to run in this job.
strategy: strategy # Execution strategy for this job.
continueOnError: string # Continue running even on failure?
pool: string | pool # Pool where jobs in this pipeline will run unless otherwise specified.
container: string | container # Container resource name.
services: # Container resources to run as a service container.
  string: string # Name/value pairs
workspace: # Workspace options on the agent.
  clean: outputs | resources | all # Which parts of the workspace should be scorched before fetching.
name: string # Pipeline run number.
appendCommitMessageToRunName: boolean # Append the commit message to the build number. The default is true.
trigger: none | trigger | [ string ] # Continuous integration triggers.
parameters: [ parameter ] # Pipeline template parameters.
pr: none | pr | [ string ] # Pull request triggers.
schedules: [ cron ] # Scheduled triggers.
resources: # Containers and repositories used in the build.
  builds: [ build ] # List of build resources referenced by the pipeline.
  containers: [ container ] # List of container images.
  pipelines: [ pipeline ] # List of pipeline resources.
  repositories: [ repository ] # List of repository resources.
  webhooks: [ webhook ] # List of webhooks.
  packages: [ package ] # List of package resources.
variables: variables | [ variable ] # Variables for this pipeline.
lockBehavior: sequential | runLatest # Behavior lock requests from this stage should exhibit in relation to other exclusive lock requests.

特性

手順stepsします。 必須。
このジョブで実行する手順の一覧です。

jobs.job.strategyを strategyします。
このジョブの実行戦略を します。

continueOnError 文字列。
障害が発生しても実行を続行しますか?

プールを poolします。
特に指定しない限り、このパイプライン内のジョブが実行されるプールです。

jobs.job.containerを containerします。
コンテナー リソース名を します。

文字列ディクショナリ services します。
サービス コンテナーとして実行するコンテナー リソースを します。

ワークスペースを workspaceします。
エージェントの [ワークスペース] オプションを します。

name 文字列。
パイプラインの実行番号。

ブールを appendCommitMessageToRunNameします。
ビルド番号にコミット メッセージを追加します。 既定値は true です。

trigger トリガー。
継続的インテグレーション トリガーを します。

パラメーターparametersします。
パイプライン テンプレート パラメーターを します。

を prします。
pull request トリガーを します。

スケジュールを schedulesします。
スケジュールされたトリガーを します。

リソースresourcesします。
ビルドで使用されるコンテナーとリポジトリ。

variables 変数。
このパイプラインの変数を します。

lockBehavior 文字列。
このステージからの動作ロック要求は、他の排他的ロック要求に関連して示す必要があります。 sequential |runLatest。

例示

trigger:
- main

pool: 
  vmImage: ubuntu-latest

steps:
- script: "Hello world!"

こちらもご覧ください

• 複数のジョブが されたパイプラインの
• トリガーの
• 変数の
• ビルド番号の形式