UniversalPackages@0 - ユニバーサル パッケージ v0 タスク

このタスクを使用して、ユニバーサル パッケージをダウンロードまたはパッケージ化して発行します。

構文

# Universal packages v0
# Download or publish Universal Packages.
- task: UniversalPackages@0
  inputs:
    command: 'download' # 'download' | 'publish'. Required. Command. Default: download.
    downloadDirectory: '$(System.DefaultWorkingDirectory)' # string. Required when command = download. Destination directory. Default: $(System.DefaultWorkingDirectory).
    #publishDirectory: '$(Build.ArtifactStagingDirectory)' # string. Required when command = publish. Path to file(s) to publish. Default: $(Build.ArtifactStagingDirectory).
  # Feed & package details
    feedsToUse: 'internal' # 'internal' | 'external'. Alias: internalOrExternalDownload. Required when command = download. Feed location. Default: internal.
    #externalFeedCredentials: # string. Alias: externalEndpoint. Optional. Use when internalOrExternalDownload = external && command = download. organization/collection connection. 
    #vstsFeed: # string. Alias: feedListDownload. Required when internalOrExternalDownload = internal && command = download. Feed. 
    #vstsFeedPackage: # string. Alias: packageListDownload. Required when internalOrExternalDownload = internal && command = download. Package name. 
    #vstsPackageVersion: # string. Alias: versionListDownload. Required when internalOrExternalDownload = internal && command = download. Version. 
    #feedDownloadExternal: # string. Required when internalOrExternalDownload = external && command = download. Feed (or Project/Feed if the feed was created in a project). 
    #packageDownloadExternal: # string. Required when internalOrExternalDownload = external && command = download. Package name. 
    #versionDownloadExternal: # string. Required when internalOrExternalDownload = external && command = download. Version. 
  # Feed & package details
    #feedsToUsePublish: 'internal' # 'internal' | 'external'. Alias: internalOrExternalPublish. Required when command = publish. Feed location. Default: internal.
    #publishFeedCredentials: # string. Alias: externalEndpoints. Required when internalOrExternalPublish = external && command = publish. organization/collection connection. 
    #vstsFeedPublish: # string. Alias: feedListPublish. Required when internalOrExternalPublish = internal && command = publish. Destination Feed. 
    #vstsFeedPackagePublish: # string. Alias: packageListPublish. Required when internalOrExternalPublish = internal && command = publish. Package name. 
    #feedPublishExternal: # string. Required when internalOrExternalPublish = external && command = publish. Feed (or Project/Feed if the feed was created in a project). 
    #packagePublishExternal: # string. Required when internalOrExternalPublish = external && command = publish. Package name. 
    #versionOption: 'patch' # 'major' | 'minor' | 'patch' | 'custom'. Alias: versionPublishSelector. Required when command = publish. Version. Default: patch.
    #versionPublish: # string. Required when versionPublishSelector = custom && command = publish. Custom version. 
    #packagePublishDescription: # string. Optional. Use when command = publish. Description. 
  # Advanced
    #publishPackageMetadata: true # boolean. Optional. Use when command = publish && internalOrExternalPublish = internal. Publish pipeline metadata. Default: true.
    #verbosity: 'None' # 'None' | 'Trace' | 'Debug' | 'Information' | 'Warning' | 'Error' | 'Critical'. Verbosity. Default: None.
  # Output
    #publishedPackageVar: # string. Optional. Use when command = publish. Package Output Variable.

入力

command - コマンド
string. 必須です。 使用できる値: download、publish。 既定値: download。

実行する NuGet コマンドを指定します。

downloadDirectory - 宛先ディレクトリ
string. command = download の場合に必要です。 既定値: $(System.DefaultWorkingDirectory)。

タスクがパッケージの内容をダウンロードするフォルダー パスを指定します。

feedsToUse - フィードの場所
入力エイリアス: internalOrExternalDownload。 string. command = download の場合に必要です。 使用できる値: internal (このorganization/コレクション) external 、(別のorganization/コレクション)。 既定値: internal。

このコレクションまたは Azure Artifacts 内の別のコレクションからのフィードを指定します。

externalFeedCredentials - organization/コレクション接続
入力エイリアス: externalEndpoint。 string. 省略可能。 の場合は internalOrExternalDownload = external && command = downloadを使用します。

選択した にある外部レジストリに使用する資格情報を指定します NuGet.config。 このorganizationまたはコレクション内のフィードの場合は、この空白のままにします。ビルドの資格情報は自動的に使用されます。

vstsFeed - フィード
入力エイリアス: feedListDownload。 string. internalOrExternalDownload = internal && command = download の場合に必要です。

選択したフィードが含まれます。 ここでフィードを選択するには、Azure Artifacts をインストールしてライセンス認証しておく必要があります。 organizationスコープフィードの FeedName と、プロジェクトスコープフィードの projectName/FeedName または ProjectID/FeedID を指定します。

vstsFeedPackage - パッケージ名
入力エイリアス: packageListDownload。 string. internalOrExternalDownload = internal && command = download の場合に必要です。

ダウンロードするタスクのパッケージの名前を指定します。

vstsPackageVersion - バージョン
入力エイリアス: versionListDownload。 string. internalOrExternalDownload = internal && command = download の場合に必要です。

パッケージのバージョンを指定するか、ダウンロードするバージョンを含む変数を使用します。 このエントリには、 などの *ワイルドカード式を指定して、最も高いバージョンを取得することもできます。 例: 1.* メジャー バージョン 1 の最高バージョンを取得し、メジャー バージョン 1 と 1.2.* マイナー バージョン 2 で最高のパッチ リリースを取得します。

feedDownloadExternal - フィード (または、フィードがプロジェクトで作成された場合はプロジェクト/フィード)
string. internalOrExternalDownload = external && command = download の場合に必要です。

別のorganization/コレクション内のフィードを指定します。

プロジェクト スコープのフィードの場合、値は である Project/Feed必要があります。ここで Project 、 はプロジェクトの名前または ID、フィード Feed の名前/ID です。 organizationスコープのフィードの場合、値はフィード名のみにする必要があります。

packageDownloadExternal - パッケージ名
string. internalOrExternalDownload = external && command = download の場合に必要です。

ダウンロードするパッケージ名を指定します。

versionDownloadExternal - バージョン
string. internalOrExternalDownload = external && command = download の場合に必要です。

パッケージのバージョンを指定するか、ダウンロードするバージョンを含む変数を使用します。 このエントリには、 などの *ワイルドカード式を指定して、最も高いバージョンを取得することもできます。 例: 1.* メジャー バージョン 1 の最高バージョンを取得し、メジャー バージョン 1 と 1.2.* マイナー バージョン 2 で最高のパッチ リリースを取得します。 ワイルドカード パターンは、プレリリース パッケージではサポートされていません。

publishDirectory - 発行するファイルへのパス
string. command = publish の場合に必要です。 既定値: $(Build.ArtifactStagingDirectory)。

発行するファイルの一覧へのパスを指定します。

feedsToUsePublish - フィードの場所
入力エイリアス: internalOrExternalPublish。 string. command = publish の場合に必要です。 使用できる値: internal (このorganization/コレクション) external 、(別のorganization/コレクション)。 既定値: internal。

このコレクションまたは Azure Artifacts 内の別のコレクションからのフィードを指定します。

publishFeedCredentials - organization/コレクション接続
入力エイリアス: externalEndpoints。 string. internalOrExternalPublish = external && command = publish の場合に必要です。

外部フィードに使用する資格情報を指定します。

vstsFeedPublish - 宛先フィード
入力エイリアス: feedListPublish。 string. internalOrExternalPublish = internal && command = publish の場合に必要です。

発行するプロジェクトとフィードの名前/GUID を指定します。

publishPackageMetadata - パイプライン メタデータを発行する
boolean. 省略可能。 の場合は command = publish && internalOrExternalPublish = internalを使用します。 既定値: true。

このビルド/リリース パイプラインのメタデータ (run # やソース コード情報など) をパッケージに関連付けます。

vstsFeedPackagePublish - パッケージ名
入力エイリアス: packageListPublish。 string. internalOrExternalPublish = internal && command = publish の場合に必要です。

このパッケージのバージョンを発行したことがない場合は、発行または新しいパッケージ ID を作成するパッケージ ID を指定します。 パッケージ名は小文字にする必要があり、文字、数字、ダッシュ (-) のみを使用できます。

feedPublishExternal - フィード (または、フィードがプロジェクトで作成された場合はプロジェクト/フィード)
string. internalOrExternalPublish = external && command = publish の場合に必要です。

発行する外部フィード名を指定します。

フィードがプロジェクトで作成された場合、値は である Project/Feed必要があります。ここで Project 、 はプロジェクトの名前または ID、フィード Feed の名前です。 フィードがプロジェクトに作成されていない場合、値はフィード名のみにする必要があります。

packagePublishExternal - パッケージ名
string. internalOrExternalPublish = external && command = publish の場合に必要です。

外部フィードに発行するときにパッケージ名を指定します。

versionOption - バージョン
入力エイリアス: versionPublishSelector。 string. command = publish の場合に必要です。 使用できる値: major (次のメジャー)、 minor (次のマイナー)、 patch (次のパッチ)、 custom。 既定値: patch。

バージョン増分戦略を指定します。 パッケージの custom バージョンを手動で入力する値。 新しいパッケージの場合、 を指定した場合は 1.0.0、を指定した場合は 0.1.0、を指定majorminorした場合は 0.0.1 patchになります。 詳細については、 セマンティック バージョン管理の仕様 に関するページを参照してください。

versionPublish - カスタム バージョン
string. versionPublishSelector = custom && command = publish の場合に必要です。

パッケージのカスタム バージョン スキーマを指定します。

packagePublishDescription - 説明
string. 省略可能。 の場合は command = publishを使用します。

パッケージの内容や、このバージョンのパッケージで行われた変更の説明を指定します。

verbosity - 詳細
string. 使用できる値: None、Trace、、Debug、Information、Warning、Error。 Critical 既定値: None。

出力に表示する詳細の量を指定します。

publishedPackageVar - パッケージ出力変数
string. 省略可能。 の場合は command = publishを使用します。

発行されたパッケージ名とバージョンを含む変数の名前を指定します。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

解説

このタスクを使用して、ユニバーサル パッケージをダウンロードまたはパッケージ化して発行します。

パイプラインが別のプロジェクトのフィードにアクセスする必要がある

フィードをホストしているプロジェクトとは異なるプロジェクトでパイプラインが実行されている場合は、ビルド サービスへの読み取り/書き込みアクセス権を付与するように他のプロジェクトを設定する必要があります。 詳細については、Azure Pipelines でのパッケージのアクセス許可に関するページを参照してください。

例

ユニバーサル パッケージ タスクを開始する最も簡単な方法は、パイプライン タスク エディターを使用して YAML を生成することです。 その後、生成されたコードをプロジェクトの azure-pipelines.yml ファイルにコピーできます。 この例では、GatsbyJS プログレッシブ Web アプリ (PWA) を構築するパイプラインを使用して YAML をすばやく生成する方法を示します。

ユニバーサル パッケージは、Web アプリのカプセル化とバージョン管理の両方に役立つ方法です。 Web アプリをユニバーサル パッケージにパッケージ化すると、特定のバージョンのサイトにすばやくロールバックでき、デプロイ パイプラインでサイトをビルドする必要がなくなります。

このパイプラインの例では、プロジェクト内のフィードからツールをフェッチする方法を示します。 ユニバーサル パッケージ タスクは、ツールのダウンロード、ビルドの実行、および再びユニバーサル パッケージ タスクを使用して、コンパイル済みの GatsbyJS PWA 全体をバージョン管理されたユニバーサル パッケージとしてフィードに発行するために使用されます。

ユニバーサル パッケージ タスクを使用してパッケージをダウンロードする

サンプル プロジェクトの 2 番目のタスクでは、ユニバーサル パッケージ タスクを使用して、同じorganization内の別のプロジェクト内にあるフィードからツール imagemagick をフェッチします。 イメージのサイズを変更するには、後続のビルド ステップで imagemagick ツールが必要です。

1. ユニバーサル パッケージ タスクを追加するには、プラス アイコンをクリックし、検索ボックスに「ユニバーサル」と入力し、[ 追加 ] ボタンをクリックしてタスクをパイプラインに追加します。

   

2. 新しく追加された ユニバーサル パッケージ タスクをクリックし、 コマンド を にクリック Downloadします。

3. ツールのダウンロードに使用する 宛先ディレクトリ を選択します。

4. ツールを含むソース フィード を選択し、 パッケージ名を設定し、ソース フィードから imagemagick ツールの バージョン を選択 します。

   

5. フィールドが完了したら、[YAML の 表示 ] をクリックして、生成された YAML を確認します。

   

6. ユニバーサル パッケージ タスク ビルダーは、既定値以外の値を含む簡略化された YAML を生成します。 生成された YAML をazure-pipelines.yml、プロジェクトの git リポジトリのルートにあるファイルにコピーします。

   # Download Universal Package
   steps:
   - task: UniversalPackages@0
     displayName: 'Universal download'
     inputs:
       downloadDirectory: Application
       vstsFeed: '00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000001'
       vstsFeedPackage: imagemagick
       vstsPackageVersion: 1.0.0
   

ユニバーサル パッケージ タスクを使用してパッケージを発行する

このサンプル パイプラインの最後の手順では、ユニバーサル パッケージ タスクを使用して、ステップによって Run gatsby build 生成された運用対応の Gatsby PWA を、バージョン管理されたユニバーサル パッケージとしてフィードにアップロードします。 フィードに入ると、完全なサイトの永続的なコピーが作成され、ホスティング プロバイダーに展開して で gatsby serve開始できます。

1. パイプラインの末尾に別のユニバーサル パッケージ タスクを追加するには、プラス アイコンをクリックし、検索ボックスに「ユニバーサル」と入力し、[ 追加 ] ボタンをクリックしてタスクをパイプラインに追加します。 このタスクは、ステップによって Run gatsby build 生成されたすべての運用対応アセットを収集し、バージョン管理されたユニバーサル パッケージを生成し、パッケージをフィードに発行します。

   

2. コマンドを にPublish設定します。

3. GatsbyJS プロジェクトpackage.jsonの を含むディレクトリに発行するには、[パス] を [ファイル] に設定します。

4. 移行先フィード、パッケージ名を選択し、バージョン管理戦略を設定します。

   

5. 必要なフィールドを入力したら、[ YAML の表示] をクリックします。

6. 結果の YAML を以前と同じようにファイルにコピーします azure-pipelines.yml 。 このサンプル プロジェクトの YAML を次に示します。

   # Publish Universal Package
   steps:
   - task: UniversalPackages@0
     displayName: 'Universal publish'
     inputs:
       command: publish
       publishDirectory: Application
       vstsFeedPublish: '00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000002' # You can also use '<projectName>/<feedName>' instead of the GUIDs
       vstsFeedPackagePublish: mygatsbysite
       packagePublishDescription: 'A test package'
   

この例では、Pipelines タスク ビルダーを使用してユニバーサル パッケージ タスクの YAML をすばやく生成し、ファイルに配置する方法を azure-pipelines.yml 示しました。 ユニバーサル パッケージ タスク ビルダーは、 ユニバーサル パッケージ タスクの引数を使用して作成できるすべての高度な構成をサポートしています。

注意

パッケージをビューに直接発行することは、Azure Artifacts ではサポートされていません。 最初にパッケージをフィードに発行してから、ビューに昇格させる必要があります。

必要条件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	Any
設定可能な変数	Any
エージェントのバージョン	2.144.0 以上
タスクのカテゴリ	Package