Azure Pipelines タスク リファレンス

タスクはパイプラインでアクションを実行します。 たとえば、タスクでは、アプリの構築、Azure リソースの操作、ツールのインストール、テストの実行などを行うことができます。 タスクは、パイプラインで自動化を定義するための構成要素です。

このセクションの記事では、Azure Pipelines の組み込みタスクについて説明し、タスクごとに特別な意味を持つ属性のセマンティクスを指定します。

タスクでサポートされる一般的な属性の詳細については、steps.task の YAML リファレンスを参照してください。

カスタム タスクの作成、カスタム拡張機能、Visual Studio Marketplace でのタスクの検索など、タスクを使用してパイプラインを作成する方法とチュートリアルについては、タスクの概念の と Azure Pipelines ドキュメント を参照してください。

オープンソース

これらのタスクは、GitHub上のオープン ソース です。 フィードバックと投稿は大歓迎です。 タスクの更新の履歴レコードなど、タスクの変更の一覧については、「パイプライン タスク変更ログの」を参照してください。

FAQ

タスク入力エイリアスとは

タスクへの入力は、label(name) によって識別され、1 つ以上の省略可能な aliasesを含めることができます。 次の例は、InstallSSHKey@0 タスクの 既知のホスト エントリ 入力に ソース コードからの抜粋です。

{
    "name": "hostName",
    "aliases": [
        "knownHostsEntry"
    ],
    "label": "Known Hosts Entry"
    ...
}

YAML パイプラインが 2019 年に導入される前は、UI ベースのパイプライン エディターを使用してパイプラインが作成および編集され、パイプライン作成者がタスク入力を参照するために使用された label のみでした。

YAML パイプラインが 2019 年に導入されたとき、YAML を使用するパイプライン作成者は、タスク入力 name を使用してタスク入力を参照し始めました。 場合によっては、タスク入力名がわかりやすいものではなかったため、タスク入力にわかりやすい名前を追加するために aliases が追加されました。

たとえば、InstallSSHKey@0 タスクには、known_hosts ファイルからのエントリを必要とする hostName という名前の 既知のホスト エントリ 入力があります。 クラシック パイプライン デザイナーの Known Hosts Entry ラベルを使用すると、これは明確になりますが、YAML パイプラインで hostName 名を使用する場合は明確ではありません。 タスク入力エイリアスが導入され、タスク作成者は以前に作成したタスクの名前を減らし、InstallSSHKey@0 タスクの場合は、元の hostName 名を保持しながら、その名前を使用して既存のパイプラインとの互換性を保ちながら、knownHostsEntryエイリアスが追加されました。

タスク入力の aliases 内のすべての項目は、YAML パイプライン内の name と交換可能です。 次の 2 つの YAML スニペットは機能的に同じです。最初の例では knownHostsEntry エイリアスを使用し、2 番目の例は hostNameを使用しています。

- task: InstallSSHKey@0
  inputs:
    # Using knownHostsEntry alias
    knownHostsEntry: 'sample known hosts entry line'
    # Remainder of task inputs omitted

- task: InstallSSHKey@0
  inputs:
    # Using hostName name
    hostName: 'sample known hosts entry line'
    # Remainder of task inputs omitted

Azure DevOps Server 2019.1 以降では、YAML パイプライン エディターが導入され、Intellisense 型の機能が提供されました。

YAML パイプライン エディターでは、Yamlschema - Get REST API を使用して、エディターでの検証に使用されるスキーマを取得します。 タスク入力にエイリアスがある場合、スキーマはエイリアスをタスク入力のプライマリ YAML 名に昇格し、intellisense によってエイリアスが提案されます。

次の例は、YAML スキーマからの InstallSSHKey@0 タスクの Known Hosts Entry タスク入力で、knownHostsEntry が名前の位置に表示され、aliases コレクションに hostName されています。

"properties": {
    "knownHostsEntry": {
      "type": "string",
      "description": "Known Hosts Entry",
      "ignoreCase": "key",
      "aliases": [
        "hostName"
      ]
    },

YAML パイプライン エディターの intellisense には knownHostsEntryが表示され、タスク アシスタント によって生成された YAML は生成された YAML で knownHostsEntry を使用するため、タスク参照ではタスクソース コードからの alias がタスク入力の YAML 名として表示されます。 タスクに複数のエイリアスがある場合 (エイリアスが 2 つあるものがあります)、最初のエイリアスが名前として使用されます。

タスク参照が変更された理由

Azure Pipelines タスクのリファレンス ドキュメントは、次の機能強化をサポートするために現在の場所に移動されました。

• タスクアーティクルは、Azure Pipelines タスクオープン ソース リポジトリのタスク ソース コードを使用して生成されます。
• タスク入力名とエイリアスは、常に最新の状態になるようにタスク ソースから生成されます。
• YAML 構文ブロックは、タスク ソースから生成されるため、最新の状態になります。
• 強化されたタスク入力の説明、解説、例など、統合されたユーザー コンテンツでコミュニティへの投稿をサポートします。
• サポートされているすべての Azure DevOps バージョンのタスク カバレッジを提供します。
• 最新の更新プログラムをカバーするために、すべてのスプリントを更新しました。

投稿するには、タスクコンテンツに貢献する を参照してください。

アプリを構築する方法の詳細については、どこで学習できますか?

アプリ をビルドする

独自のビルド タスクを追加できますか?

はい: ビルド タスク を追加する

インストーラー タスクとは

ツール インストーラー タスクの詳細については、「ツール インストーラーの」を参照してください。