タスクの種類と使用法

YAML では、タスク名に @ を使用してメジャー バージョンを指定します。 たとえば、 PublishTestResults タスクのバージョン 2 を使用するには、 PublishTestResults@2を指定します。 @など、GoTool@0.3.1の後に完全なタスク バージョン番号を指定することで、使用するマイナー バージョンを指定できます。

クラシック パイプラインでは、各タスクに バージョン セレクターがあり、必要なバージョンを選択できます。 パイプラインを複製し、複製されたパイプラインを新しいメジャー タスク バージョンでテストすることを検討してください。 1.* Preview などのプレビュー バージョンを選択した場合、バージョンはまだ開発中であり、問題が発生する可能性があります。

バージョンを変更し、ビルドに問題がある場合は、[ 履歴 ] タブからパイプラインの変更を元に戻すことができます。リリース パイプラインの場合、古いバージョンに復元することはできません。 リリース パイプラインへの変更を手動で戻してから、パイプラインを保存する必要があります。

YAML パイプラインの task 手順では、次のプロパティを使用できます。 詳細については、 steps.task の定義を参照してください。

条件

タスクは、タスクが完了した後にパイプライン ジョブを続行するかどうかを判断できません。 succeeded や failedなどの終了状態のみを提供します。 その後、ダウンストリームのタスクとジョブは、その状態に基づいて condition を設定して、実行するかどうかを決定できます。

conditions プロパティは、このタスクを実行する条件を指定します。 既定では、ジョブ内の何も失敗せず、その直前のステップが完了した場合、ステップが実行されます。

以前の依存関係が失敗した場合や別の結果が得られた場合にのみ、実行するようにステップを設定することで、これらの既定値をオーバーライドまたはカスタマイズできます。 式で構成されるカスタム条件を定義することもできます。

以前の依存関係の状態に基づく条件は次のとおりです。

• 成功: 以前のすべての依存関係が成功した場合にのみ実行します。 この動作は、YAML に条件が設定されていない場合の既定値です。 この条件を適用するには、 condition: succeeded()を指定します。
• 成功または失敗: 実行が取り消されない限り、以前の依存関係が失敗した場合でも実行します。 この条件を適用するには、 condition: succeededOrFailed()を指定します。
• 常に: 実行が取り消された場合でも、以前の依存関係が失敗した場合でも実行します。 この条件を適用するには、 condition: always()を指定します。
• 失敗: 以前の依存関係が失敗した場合にのみ実行されます。 この条件を適用するには、 condition: failed()を指定します。

次の YAML の例では、 PublishTestResults@2 は、前の手順が失敗した場合でも、 その成功したOrFailed 条件が原因で実行されます。

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

エラーが発生した場合に続行する

continueOnError プロパティは、失敗に関係なく、実行を継続して成功を報告するかどうかをタスクに指示します。 trueに設定した場合、このプロパティはタスクにfailed状態を無視して実行を続行するように指示します。 ダウンストリームのステップとジョブは、実行の決定を行うときにタスクの結果を success として扱います。

Enabled

既定では、ジョブが実行されるたびにタスクが実行されます。 タスクを無効にするには、 enabled を false に設定できます。 タスクを一時的に無効にすると、テスト目的または特定のデプロイのプロセスからタスクを削除するのに役立ちます。

タスクの失敗時の再試行回数

retryCountOnTaskFailure プロパティは、失敗した場合にタスクを再試行する回数を指定します。 既定値は、再試行回数 0 回です。

• 最大再試行回数は 10 回です。
• 再試行が失敗するたびに、指数バックオフ戦略に従って再試行までの待機時間が長くなります。 最初の再試行は 1 秒後、2 回目は 4 秒後、10 回目の再試行は 100 秒後に行われます。
• タスクを再試行してもべき等性は提供されません。 外部リソースの部分的な作成など、最初の試行の副作用により、再試行が失敗する可能性があります。
• 再試行回数に関する情報はタスクで使用できません。
• タスクの失敗により、タスクを再試行する前に失敗したことを示す警告がタスク ログに追加されます。
• すべての再試行は、同じタスク ノードの一部として UI に表示されます。

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

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

タイムアウト

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

クラシック パイプラインでは、タスクにはいくつかの コントロール オプションが用意されています。

Enabled

タスクを無効にするには、[ 有効] チェック ボックスをオフにします。 タスクを一時的に無効にすると、テスト目的または特定のデプロイのプロセスからタスクを削除するのに役立ちます。

エラーが発生した場合に続行する

このタスクが失敗した場合でも成功を報告し、同じジョブ内の依存タスクの実行を許可する場合は、このオプションを選択します。 全体的なビルドまたはデプロイは、部分的に成功する必要があります。 後続のタスクを実行するかどうかは、[ このタスクの実行] 設定によっても異なります。

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

このタスクが失敗した場合の再試行回数を指定します。 既定値は 0 です。

• 失敗したタスクは数秒以内に再試行されます。 再試行が失敗するたびに再試行までの待機時間が長くなります。
• タスクを再試行してもべき等性は提供されません。 外部リソースの部分的な作成など、最初の試行の副作用により、再試行が失敗する可能性があります。
• 再試行回数に関する情報は、タスクで使用できません。
• タスクの失敗により、タスクを再試行する前に失敗したことを示す警告がタスク ログに追加されます。
• すべての再試行は、同じタスク ノードの一部として UI に表示されます。

タイムアウト

タスクが自動的に取り消されるまでに実行できる最大時間 (分) を入力します。 既定値は 0、または無限時間です。 0 以外の値を設定すると、親タスク ジョブの設定がオーバーライドされます。 タイムアウト期間は、タスクの実行が開始されたときに開始され、タスクがキューに登録されているか、エージェントを待機している時間は含まれません。

このタスクを実行

このタスクを実行するには、次のいずれかの条件を選択します。

• 前のすべてのタスクが成功した場合のみ。 この条件が既定です。
• 前のタスクが失敗した場合でも、ビルドが取り消されていない場合
• 前のタスクが失敗した場合でも、ビルドが取り消された場合でも
• 前のタスクが失敗した場合のみ
• カスタム条件を入力し、このタスクを実行する必要がある場合の式を指定する カスタム条件 を入力します。

YAML パイプライン タスクでは、環境変数を表す名前/値文字列を一覧表示する env プロパティを指定できます。

- task: AzureCLI@2
  env:
    ENV_VARIABLE_NAME: value
    ENV_VARIABLE_NAME2: value
  ...

環境変数は、 script 手順を使用するか、コマンド ライン、Bash、または PowerShell タスクでスクリプトを使用して設定できます。

次の例では、script環境変数に値を割り当て、値をエコーするENV_VARIABLE_NAMEステップを実行します。

- script: echo "This is " $ENV_VARIABLE_NAME
  env:
    ENV_VARIABLE_NAME: value
  displayName: 'echo environment variable'

上記のスクリプトは、機能的には、入力をscript タスクを実行する場合と同じです。 次の例では、 task 構文を使用します。

- task: Bash@3
  inputs:
    script: echo "This is " $ENV_VARIABLE_NAME
  env:
    ENV_VARIABLE_NAME: value
  displayName: 'echo environment variable'

クラシック パイプラインでは、タスク エディターの [ 環境変数] セクション で環境変数を追加および編集できます。

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

pool:
  vmImage: 'windows-latest'

jobs:
- job: NodeJS
  strategy:
    matrix:
      node14:
        nodeVersion: '14.x'
      node16:
        nodeVersion: '16.x'
    maxParallel: 2
  steps:
    - task: NodeTool@0
      displayName: 'Install Node.js $(nodeVersion)'
      inputs:
        versionSpec: '$(nodeVersion)'
        checkLatest: true

    - script: |
        echo Using Node version $(nodeVersion)
        node --version
      displayName: 'Verify Node Installation'

パイプラインを保存して実行します。 ジョブは、 nodeVersion 変数で指定した Node.js のバージョンごとに 1 つずつ、2 回実行されます。

Node.js ツール インストーラーでは、Node.js バージョンがまだエージェント上にない場合はダウンロードされます。 コマンド ライン スクリプトは、インストールされているバージョンをコマンド ラインに書き込みます。

1. クラシック パイプラインの エージェント ジョブ で、[ 実行プラン] で [ 並列処理 ] を [複数構成] に設定します。

2. [乗数] に「nodeVersion」と入力します。

3. エージェントの最大数を 2 に設定します。

4. 次の設定を使用して 、Node.js ツール インストーラー タスクをパイプラインに追加します。

   • バージョン スペックの下に「$(nodeVersion)」と入力します。
   • [ 最新バージョンのチェック] のチェック ボックスをオンにします。

5. パイプラインに コマンド ライン タスクを追加し、[ スクリプト] に次のコードを入力します。

   echo Using Node version $(nodeVersion)
node --version

6. [変数] タブで、値 14.x、16.x で変数 nodeVersion を定義し、キュー時に Settable を選択します。

   注意

   リリース パイプラインで、 リリース時に [Settable] を選択します。 詳細については、「リリース時に変数を編集する方法」を参照してください。

7. [保存して & キューに登録] を選択します。

8. [ パイプラインの実行 ] 画面で、[ 保存して実行] を選択します。

ジョブは、 nodeVersion 変数で指定した Node.js のバージョンごとに 1 つずつ、2 回実行されます。 Node.js ツール インストーラー タスクは、Node.js バージョンがまだエージェントに存在しない場合にダウンロードします。 コマンド ライン タスクは、ディスク上の Node.js バージョンの場所をログに記録します。