NuGetCommand@2 - NuGet v2 タスク

このタスクを使用して、NuGet パッケージの復元、パック、プッシュ、または NuGet コマンドの実行を行います。 このタスクは、Azure Artifacts や MyGet などの NuGet.org および認証済みフィードをサポートします。 このタスクでは、NuGet.exe も使用され、.NET Framework アプリで動作します。 .NET Core アプリと .NET Standard アプリの場合は、.NET Core タスクを使用します。

構文

# NuGet v2
# Restore, pack, or push NuGet packages, or run a NuGet command. Supports NuGet.org and authenticated feeds like Azure Artifacts and MyGet. Uses NuGet.exe and works with .NET Framework apps. For .NET Core and .NET Standard apps, use the .NET Core task.
- task: NuGetCommand@2
  inputs:
    command: 'restore' # 'restore' | 'pack' | 'push' | 'custom'. Required. Command. Default: restore.
    restoreSolution: '**/*.sln' # string. Alias: solution. Required when command = restore. Path to solution, packages.config, or project.json. Default: **/*.sln.
    #packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg' # string. Alias: searchPatternPush. Required when command = push. Path to NuGet package(s) to publish. Default: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.
    #nuGetFeedType: 'internal' # 'internal' | 'external'. Required when command = push. Target feed location. Default: internal.
    #publishVstsFeed: # string. Alias: feedPublish. Required when command = push && nuGetFeedType = internal. Target feed. 
    #allowPackageConflicts: false # boolean. Optional. Use when command = push && nuGetFeedType = internal. Allow duplicates to be skipped. Default: false.
    #publishFeedCredentials: # string. Alias: externalEndpoint. Required when command = push && nuGetFeedType = external. NuGet server. 
    #packagesToPack: '**/*.csproj' # string. Alias: searchPatternPack. Required when command = pack. Path to csproj or nuspec file(s) to pack. Default: **/*.csproj.
    #configuration: '$(BuildConfiguration)' # string. Alias: configurationToPack. Optional. Use when command = pack. Configuration to package. Default: $(BuildConfiguration).
    #packDestination: '$(Build.ArtifactStagingDirectory)' # string. Alias: outputDir. Optional. Use when command = pack. Package folder. Default: $(Build.ArtifactStagingDirectory).
    #arguments: # string. Required when command = custom. Command and arguments. 
  # Feeds and authentication
    feedsToUse: 'select' # 'select' | 'config'. Alias: selectOrConfig. Required when command = restore. Feeds to use. Default: select.
    #vstsFeed: # string. Alias: feedRestore. Optional. Use when selectOrConfig = select && command = restore. Use packages from this Azure Artifacts/TFS feed. Select from the dropdown or enter [project name/]feed name. 
    #includeNuGetOrg: true # boolean. Optional. Use when selectOrConfig = select && command = restore. Use packages from NuGet.org. Default: true.
    #nugetConfigPath: # string. Optional. Use when selectOrConfig = config && command = restore. Path to NuGet.config. 
    #externalFeedCredentials: # string. Alias: externalEndpoints. Optional. Use when selectOrConfig = config && command = restore. Credentials for feeds outside this organization/collection. 
  # Advanced
    #noCache: false # boolean. Optional. Use when command = restore. Disable local cache. Default: false.
    #disableParallelProcessing: false # boolean. Optional. Use when command = restore. Disable parallel processing. Default: false.
    #restoreDirectory: # string. Alias: packagesDirectory. Optional. Use when command = restore. Destination directory. 
    #verbosityRestore: 'Detailed' # 'Quiet' | 'Normal' | 'Detailed'. Optional. Use when command = restore. Verbosity. Default: Detailed.
  # Advanced
    #publishPackageMetadata: true # boolean. Optional. Use when command = push && nuGetFeedType = internal && command = push. Publish pipeline metadata. Default: true.
    #verbosityPush: 'Detailed' # 'Quiet' | 'Normal' | 'Detailed'. Optional. Use when command = push. Verbosity. Default: Detailed.
  # Pack options
    #versioningScheme: 'off' # 'off' | 'byPrereleaseNumber' | 'byEnvVar' | 'byBuildNumber'. Required when command = pack. Automatic package versioning. Default: off.
    #includeReferencedProjects: false # boolean. Optional. Use when versioningScheme = off && command = pack. Include referenced projects. Default: false.
    #versionEnvVar: # string. Required when versioningScheme = byEnvVar && command = pack. Environment variable. 
    #majorVersion: '1' # string. Alias: requestedMajorVersion. Required when versioningScheme = byPrereleaseNumber && command = pack. Major. Default: 1.
    #minorVersion: '0' # string. Alias: requestedMinorVersion. Required when versioningScheme = byPrereleaseNumber && command = pack. Minor. Default: 0.
    #patchVersion: '0' # string. Alias: requestedPatchVersion. Required when versioningScheme = byPrereleaseNumber && command = pack. Patch. Default: 0.
    #packTimezone: 'utc' # 'utc' | 'local'. Optional. Use when versioningScheme = byPrereleaseNumber && command = pack. Time zone. Default: utc.
    #includeSymbols: false # boolean. Optional. Use when command = pack. Create symbols package. Default: false.
    #toolPackage: false # boolean. Optional. Use when command = pack. Tool Package. Default: false.
  # Advanced
    #buildProperties: # string. Optional. Use when command = pack. Additional build properties. 
    #basePath: # string. Optional. Use when command = pack. Base path. 
    #verbosityPack: 'Detailed' # 'Quiet' | 'Normal' | 'Detailed'. Optional. Use when command = pack. Verbosity. Default: Detailed.

入力

command - コマンド
string. 必須。 使用できる値: restore、pack、push、custom。 既定値: restore.

実行する NuGet コマンドを指定します。 引数を追加したり、別のコマンドを使用したりするには、custom 値を使用します。

restoreSolution - ソリューション、packages.config、または project.json へのパス
入力エイリアス: solution。 string. command = restoreする場合に必要です。 既定値: **/*.sln.

復元するパッケージを参照するソリューション、packages.config、または project.json ファイルへのパスを指定します。

を使用するフィードを する
入力エイリアス: selectOrConfig。 string. command = restoreする場合に必要です。 使用できる値: select (ここで選択したフィード)、config (NuGet.configのフィード)。 既定値: select.

select 値で使用するタスクの Azure Artifacts や NuGet.org からのフィードを指定します。 または、NuGet.config ファイルをソース コード リポジトリにコミットし、config 値を使用してそのパスを値として設定することもできます。

vstsFeed - この Azure Artifacts/TFS フィードのパッケージを使用します。ドロップダウンから選択するか、[プロジェクト名/]フィード名を入力します。
入力エイリアス: feedRestore。 string. 随意。 selectOrConfig = select && command = restoreするときに使用します。

生成された NuGet.configで選択したフィードを指定します。 ここでフィードを指定するには、パッケージ管理がインストールされ、ライセンスが付与されている必要があります。

includeNuGetOrg - NuGet.org のパッケージを使用する
boolean. 随意。 selectOrConfig = select && command = restoreするときに使用します。 既定値: true.

生成された NuGet.configに NuGet.org が含まれます。

NuGet.config へのパスの
string. 随意。 selectOrConfig = config && command = restoreするときに使用します。

パッケージの復元元のフィードを決定するリポジトリ内の NuGet.config へのパスを指定します。

この組織またはコレクション の外部にあるフィードの 資格情報
入力エイリアス: externalEndpoints。 string. 随意。 selectOrConfig = config && command = restoreするときに使用します。

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

noCache - ローカル キャッシュの を無効にする
boolean. 随意。 command = restoreするときに使用します。 既定値: false.

trueに設定すると、NuGet がローカル コンピューター キャッシュのパッケージを使用できないようにします。

disableParallelProcessing - 並列処理 を無効にする
boolean. 随意。 command = restoreするときに使用します。 既定値: false.

trueに設定すると、NuGet が複数のパッケージを並列プロセスにインストールできなくなります。

宛先ディレクトリ を する
入力エイリアス: packagesDirectory。 string. 随意。 command = restoreするときに使用します。

パッケージをインストールするフォルダーを指定します。 フォルダーが指定されていない場合、パッケージは、選択したソリューション、packages.config、または project.jsonと共に packages/ フォルダーに復元されます。

verbosityRestore - 詳細度
string. 随意。 command = restoreするときに使用します。 使用できる値: Quiet、Normal、Detailed。 既定値: Detailed.

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

を発行する NuGet パッケージへのパスを する
入力エイリアス: searchPatternPush。 string. command = pushする場合に必要です。 既定値: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.

一致するパターン、またはアップロードする nupkg ファイルへのパスを指定します。 複数のパターンはセミコロンで区切ることができます。

ターゲット フィードの場所 を する
string. command = pushする場合に必要です。 使用できる値: internal (この組織/コレクション)、external (外部 NuGet サーバー (他のアカウント/コレクションを含む)。 既定値: internal.

ターゲット フィードが内部フィード/コレクションであるか、外部 NuGet サーバーであるかを指定します。

ターゲット フィード を する
入力エイリアス: feedPublish。 string. command = push && nuGetFeedType = internalする場合に必要です。

このアカウントでホストされているフィードを指定します。 ここでフィードを選択するには、Azure Artifacts がインストールされ、ライセンスが付与されている必要があります。

publishPackageMetadata - パイプライン メタデータ を発行する
boolean. 随意。 command = push && nuGetFeedType = internal && command = pushするときに使用します。 既定値: true.

継続的に発行される一連のパッケージ内の変更されたパッケージのサブセットのバージョン番号を変更します。

allowPackageConflicts - 重複のスキップを許可する
boolean. 随意。 command = push && nuGetFeedType = internalするときに使用します。 既定値: false.

一部のパッケージが 409 競合エラーで拒否された場合でも、タスクの成功を報告します。

現在、このオプションは Azure Pipelines および Windows エージェントでのみ使用できます。 NuGet.exe 競合が発生した場合、タスクは失敗します。 このオプションは機能せず、プロキシ環境内にある場合、発行は失敗します。

NuGet サーバー を する
入力エイリアス: externalEndpoint。 string. command = push && nuGetFeedType = externalする場合に必要です。

外部 NuGet サーバーの資格情報を含む NuGet サービス接続を指定します。

verbosityPush - 詳細度
string. 随意。 command = pushするときに使用します。 使用できる値: Quiet、Normal、Detailed。 既定値: Detailed.

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

packagesToPack - をパックする csproj または nuspec ファイルへのパス
入力エイリアス: searchPatternPack。 string. command = packする場合に必要です。 既定値: **/*.csproj.

タスクがパックする csproj ディレクトリを検索するために使用するパターンを指定します。

複数のパターンをセミコロンで区切ることができ、パターンの前に !を付けることで、パターンを負にすることができます。 例: **\*.csproj;!**\*.Tests.csproj.

をパッケージ化する構成の
入力エイリアス: configurationToPack。 string. 随意。 command = packするときに使用します。 既定値: $(BuildConfiguration).

csproj ファイルを使用するときにパッケージ化する構成を指定します。

packDestination - パッケージ フォルダーの
入力エイリアス: outputDir。 string. 随意。 command = packするときに使用します。 既定値: $(Build.ArtifactStagingDirectory).

タスクがパッケージを作成するフォルダーを指定します。 値が空の場合、タスクはソース ルートにパッケージを作成します。

versioningScheme - パッケージの自動バージョン管理
string. command = packする場合に必要です。 使用できる値: off、byPrereleaseNumber (日付と時刻の使用)、byEnvVar (環境変数を使用)、byBuildNumber (ビルド番号を使用)。 既定値: off.

指定した値に応じて、パッケージの自動バージョン管理を適用します。 この文字列は、includeReferencedProjectsでは使用できません。 使用できる値は次のとおりです。

• byPrereleaseNumber - 日付と時刻のを使用する: タスクは、X、Y、Z の値を指定する X.Y.Z-ci-datetime形式の SemVer準拠バージョンを生成します。
• byEnvVar - 環境変数を使用する: タスクでは、指定した環境変数が使用され、使用するバージョン番号が含まれます。
• byBuildNumber - ビルド番号を使用します。タスクはビルド番号を使用してパッケージのバージョンを作成します。

手記

[全般] で、ビルド形式を $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)に設定します。

includeReferencedProjects - 参照先プロジェクトの を含める
boolean. 随意。 versioningScheme = off && command = packするときに使用します。 既定値: false.

参照先のプロジェクトを依存関係として、またはパッケージの一部として含めます。 パッケージの自動バージョン管理では使用できません。 参照先のプロジェクトに、プロジェクトと同じ名前の対応する nuspec ファイルがある場合、その参照先プロジェクトは依存関係として追加されます。 それ以外の場合は、参照先のプロジェクトがパッケージの一部として追加されます。 NuGet CLI の pack コマンドを使用して NuGet パッケージを作成の詳細について説明します。

環境変数 versionEnvVar -
string. versioningScheme = byEnvVar && command = packする場合に必要です。

$、$env、または %を指定せずに変数名を指定します。

majorVersion - メジャー
入力エイリアス: requestedMajorVersion。 string. versioningScheme = byPrereleaseNumber && command = packする場合に必要です。 既定値: 1.

バージョンの XX.Y.Z。

minorVersion - マイナー
入力エイリアス: requestedMinorVersion。 string. versioningScheme = byPrereleaseNumber && command = packする場合に必要です。 既定値: 0.

バージョンの YX.Y.Z。

patchVersion - Patch
入力エイリアス: requestedPatchVersion。 string. versioningScheme = byPrereleaseNumber && command = packする場合に必要です。 既定値: 0.

バージョンの ZX.Y.Z。

タイム ゾーン を する
string. 随意。 versioningScheme = byPrereleaseNumber && command = packするときに使用します。 使用できる値: utc、local (エージェントのローカル時刻)。 既定値: utc.

パッケージのバージョンの生成に使用する目的のタイム ゾーンを指定します。 ホストされたビルド エージェントを使用している場合は、utc を選択することをお勧めします。日付と時刻が異なる場合があります。

includeSymbols - シンボル パッケージ を作成する
boolean. 随意。 command = packするときに使用します。 既定値: false.

パッケージにソースとシンボルが含まれていることを指定します。 .nuspec ファイルと共に使用すると、通常の NuGet パッケージ ファイルと対応するシンボル パッケージが作成されます。

toolPackage - ツール パッケージの
boolean. 随意。 command = packするときに使用します。 既定値: false.

プロジェクトの出力ファイルをツール フォルダーに含めるかどうかを決定します。

buildProperties - 追加のビルド プロパティ
string. 随意。 command = packするときに使用します。

トークンと値のペアのリストをセミコロンで区切って指定します。ここで、.nuspec ファイル内の $token$ が発生するたびに、指定された値に置き換えられます。 値には、引用符で囲まれた文字列を指定できます。

basePath - 基本パスの
string. 随意。 command = packするときに使用します。

nuspec ファイルで定義されているファイルの基本パスを指定します。

verbosityPack - 詳細度
string. 随意。 command = packするときに使用します。 使用できる値: Quiet、Normal、Detailed。 既定値: Detailed.

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

arguments - コマンドと引数の
string. command = customする場合に必要です。

実行のために NuGet.exe に渡されるコマンドと引数を指定します。 NuGet 3.5 以降が使用されている場合、この組織内のフィードまたは Project Collection Build Service がアクセスできるコレクションに対して、list、restore、publish などの認証されたコマンドが自動的に認証されます。

タスク コントロールのオプション

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

出力変数

何一つ。

備考

大事な

NuGet 認証 タスクは、Azure Artifacts やその他の NuGet リポジトリで認証するための新しい推奨される方法です。 このタスクは新しい機能を使用しなくなり、重大なバグのみが対処されます。

このタスクを使用して、NuGet パッケージの依存関係をインストールして更新するか、NuGet パッケージをパッケージ化して発行します。 NuGet.exe を使用し、.NET Framework アプリで動作します。 .NET Core アプリと .NET Standard アプリの場合は、.NET Core タスクを使用します。

コードが NuGet パッケージに依存している場合は、Visual Studio ビルド タスクの前に、この手順を必ず追加してください。 また、そのタスクで非推奨の NuGet パッケージの復元 チェック ボックスをオフにしてください。

.NET Core または .NET Standard を使用している場合は、.NET Core タスクを使用します。このタスクは、すべてのパッケージ シナリオを完全にサポートしており、現在 dotnet でサポートされています。

先端

このバージョンの NuGet タスクでは、既定で NuGet 4.1.0 が使用されます。 別のバージョンの NuGet を選択するには、ツール インストーラーを使用します。

バージョン管理スキーム

byPrereleaseNumberの場合、バージョンは、メジャー バージョン、マイナー バージョン、パッチに選択した値に加えて、yyyymmdd-hhmmss形式の日付と時刻に設定されます。

byEnvVarの場合、バージョンは、versionEnvVar パラメーターで指定された名前を持つ環境変数の値 (例: MyVersion ($なし、環境変数名のみ) に設定されます。 環境変数が適切な SemVer (1.2.3 や 1.2.3-beta1など) に設定されていることを確認します。

byBuildNumberの場合、バージョンはパイプライン実行のビルド番号を使用して設定されます。 これは、パイプラインの name プロパティに指定された値で、BUILD_BUILDNUMBER 環境変数に保存されます)。 使用されているビルド番号に適切な SemVer (1.0.$(Rev:r)など) が含まれていることを確認します。 byBuildNumberを使用すると、タスクはビルド番号文字列から点線のバージョン 1.2.3.4を抽出し、その部分のみを使用します。 残りの文字列は削除されます。 ビルド番号をそのまま使用する場合は、前述のように byEnvVar を使用し、versionEnvVar を BUILD_BUILDNUMBERに設定できます。

NuGetInstaller@0またはNuGetRestore@1から移行する

NuGetInstaller@0 と NuGetRestore@1 は非推奨となり、パイプライン内でそれらを NuGetCommand@2に置き換える必要があります。

restoreMode: restoreで NuGetInstaller@0 を使用していた場合は、NuGetCommand@2を使用するときに次の入力を構成します。

タスク入力NuGetCommand@2	価値
command	restore
restoreSolution	.sln ファイルのパス

restoreMode: installで NuGetInstaller@0 を使用していた場合は、NuGetCommand@2を使用するときに次の入力を構成します。

タスク入力NuGetCommand@2	価値
command	custom
arguments	NuGet CLI での完全インストール コマンドの外観。 たとえば、パイプラインで同等の nuget install ninject -OutputDirectory c:\proj を実行する場合、arguments パラメーターは install ninject -OutputDirectory c:\projされます。 NuGetInstaller@0 nuGetRestoreArgs パラメーターを使用していた場合は、これらも argumentsに入ります。

NuGetRestore@1を使用していた場合は、NuGetCommand@2を使用するときに次の入力を構成します。

タスク入力NuGetCommand@2	価値
command	restore
restoreSolution	.sln ファイルのパス

NuGetRestore@1 または NuGetInstaller@0restore オプションの使用と同様に、NuGetCommand@2 にはフィードを設定するための入力、select または configの決定、NuGet.config ファイルへのパスの指定、nuget.org からのパッケージの使用が含まれます。

詳細については、次の 例参照してください。

例

戻す

選択したフィードからパッケージを使用して、すべてのソリューションを復元します。

# Restore from a project scoped feed in the same organization
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    vstsFeed: 'my-project/my-project-scoped-feed'
    includeNuGetOrg: false
    restoreSolution: '**/*.sln'

# Restore from an organization scoped feed in the same organization
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    vstsFeed: 'my-organization-scoped-feed'
    restoreSolution: '**/*.sln'

# Restore from a feed in a different organization
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: config
    nugetConfigPath: ./nuget.config
    restoreSolution: '**/*.sln'
    externalFeedCredentials: 'MyServiceConnectionName'
    noCache: true
  continueOnError: true

# Restore from feed(s) set in nuget.config
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: 'config'
    nugetConfigPath: 'nuget.config'

パッケージ

移動先フォルダーに NuGet パッケージを作成します。

# Package a project
- task: NuGetCommand@2
  inputs:
    command: 'pack'
    packagesToPack: '**/*.csproj'
    packDestination: '$(Build.ArtifactStagingDirectory)'

押す

手記

パイプライン成果物は、Pipeline.Workspace ディレクトリとクラシック リリース パイプラインの System.ArtifactsDirectory ディレクトリにダウンロードされます。 packagesToPush 値は、それぞれ $(Pipeline.Workspace)/**/*.nupkg または $(System.ArtifactsDirectory)/**/*.nupkg に設定できます。

• NuGet.configで定義されているフィードにパッケージをプッシュ/発行します。

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg'
      feedsToUse: 'config'
      nugetConfigPath: '$(Build.WorkingDirectory)/NuGet.config'
  

• 組織のスコープ フィードにパッケージをプッシュ/発行する

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      nuGetFeedType: 'internal'
      publishVstsFeed: 'my-organization-scoped-feed'
  

• プロジェクト スコープ フィードにパッケージをプッシュ/発行する

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      nuGetFeedType: 'internal'
      publishVstsFeed: 'my-project/my-project-scoped-feed'
  

• パッケージを NuGet.org にプッシュ/発行する

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      feedsToUse: 'config'
      includeNugetOrg: 'true'
  

習慣

既定以外の NuGet コマンド (パック、プッシュ、復元) を実行します。

# list local NuGet resources.
- task: NuGetCommand@2
  displayName: 'list locals'
  inputs:
    command: custom
    arguments: 'locals all -list'

必要条件

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