タスクの種類と使用方法

YAML では、タスク名に @ を使用してメジャー バージョンを指定します。 たとえば、PublishTestResults タスクのバージョン 2 にピン留めするには、次のようにします。

steps:
- task: PublishTestResults@2

YAML パイプラインは TFS では使用できません。

管理オプションは、task セクションのキーとして使用できます。

- task: string # Required as first property. Name of the task to run.
  inputs: # Inputs for the task.
    string: string # Name/value pairs
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.

管理オプションは、task セクションのキーとして使用できます。

- task: string # Required as first property. Name of the task to run.
  inputs: # Inputs for the task.
    string: string # Name/value pairs
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  target: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.

管理オプションは、task セクションのキーとして使用できます。

- task: string # Required as first property. Name of the task to run.
  inputs: # Inputs for the task.
    string: string # Name/value pairs
  condition: string # Evaluate this condition expression to determine whether to run this task.
  continueOnError: boolean # Continue running even on failure?
  displayName: string # Human-readable name for the task.
  target: string | target # Environment in which to run this task.
  enabled: boolean # Run this task when the job runs?
  env: # Variables to map into the process's environment.
    string: string # Name/value pairs
  name: string # ID of the step.
  timeoutInMinutes: string # Time to wait for this task to complete before the server kills it.
  retryCountOnTaskFailure: string # Number of retries if the task fails.

タイムアウト期間は、タスクの実行が開始されたときに開始されます。 これには、タスクがキューに入っている時間やエージェントを待機している時間は含まれません。

この YAML で、PublishTestResults@2 は、succeededOrFailed() 条件のために前の手順が失敗した場合にも実行されます。

steps:
- task: UsePythonVersion@0
  inputs:
    versionSpec: '3.x'
    architecture: 'x64'
- task: PublishTestResults@2
  inputs:
    testResultsFiles: "**/TEST-*.xml"
  condition: succeededOrFailed()

条件

• 同じエージェント プールで以前の直接および間接の依存関係がすべて成功した場合のみに実行。 エージェント プールが異なる場合、これらのステージまたはジョブは同時に実行されます。 YAML に条件が設定されていない場合は、この条件が既定値になります。

• 実行が取り消された場合を除き、以前の依存関係が失敗した場合でも実行。 この条件の YAML では succeededOrFailed() を使用します。

• 実行が取り消された場合も含め、以前の依存関係が失敗した場合でも実行。 この条件の YAML では always() を使用します。

• 前の依存関係が失敗したときのみ実行。 この条件の YAML では failed() を使用します。

• 式で構成されるカスタム条件

ステップ ターゲット

タスクは、エージェント ホストまたはコンテナーである実行コンテキストで実行されます。 target を指定すると、個々のステップでコンテキストをオーバーライドできます。 使用可能なオプションは、エージェント ホストとパイプラインで定義されているコンテナーをターゲットにするワード host です。 次に例を示します。

resources:
  containers:
  - container: pycontainer
    image: python:3.11

steps:
- task: SampleTask@1
  target: host
- task: AnotherTask@1
  target: pycontainer

ここでは、SampleTask はホスト上で実行され、AnotherTask はコンテナーで実行されます。

タスクが失敗した場合の再試行回数

タスクが失敗した場合の再試行回数を指定するには、retryCountOnTaskFailure を使用します。 既定値は、再試行回数 0 回です。 タスクのプロパティの詳細については、YAML スキーマの steps.task に関する記事を参照してください。

- task: <name of task>
  retryCountOnTaskFailure: <max number of retries>
   ...

YAML パイプラインは TFS では使用できません。

- task: AzureCLI@2
  displayName: Azure CLI
  inputs: # Specific to each task
  env:
    ENV_VARIABLE_NAME: value
    ENV_VARIABLE_NAME2: value
  ...

次の例では、script ステップを実行します。これは、コマンド ライン タスクのショートカットであり、その後には同等のタスク構文が続きます。 この例では、Azure DevOps CLI での認証に使用される AZURE_DEVOPS_EXT_PAT 環境変数に値を割り当てます。

# Using the script shortcut syntax
- script: az pipelines variable-group list --output table
  env:
    AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)
  displayName: 'List variable groups using the script step'

# Using the task syntax
- task: CmdLine@2
  inputs:
    script: az pipelines variable-group list --output table
  env:
    AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)
  displayName: 'List variable groups using the command line task'

- task: Bash@3
  inputs:
     targetType: # specific to each task
  env:
    ENV_VARIABLE_NAME: value
    ENV_VARIABLE_NAME2: value
  ...

次の例では、Bash@3 のショートカットである script ステップを実行しており、その後に等価の task 構文を示しています。 この例では、ENV_VARIABLE_NAME 環境変数に値を割り当て、その値をエコーしています。

# Using the script shortcut syntax
- script: echo "This is " $ENV_VARIABLE_NAME
  env:
    ENV_VARIABLE_NAME: "my value"
  displayName: 'echo environment variable'

# Using the task syntax
- task: Bash@2
  inputs:
    script: echo "This is " $ENV_VARIABLE_NAME
  env:
    ENV_VARIABLE_NAME: "my value"
  displayName: 'echo environment variable'

次の内容を含む azure-pipelines.yml ファイルをプロジェクトのベース ディレクトリに作成します。

pool:
  vmImage: ubuntu-latest

steps:
# Node install
- task: UseNode@1
  displayName: Node install
  inputs:
    version: '16.x' # The version we're installing
# Write the installed version to the command line
- script: which node

新しいビルド パイプラインを作成して、実行します。 ビルドが実行されるのを確認します。 Node.js ツール インストーラーでは、Node.js バージョンがまだエージェント上にない場合はダウンロードされます。 コマンド ライン スクリプトは、ディスク上の Node.js バージョンの場所をログに記録します。

YAML パイプラインは TFS では使用できません。