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. 
    #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、pushcustom。 既定値: restore。

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

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

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

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

値と共に使用するタスクの Azure Artifacts や NuGet.org からのフィードを select 指定します。 または、ファイルを 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 が含まれます。

nugetConfigPath - NuGet.configへのパス
string. 省略可能。 の場合は selectOrConfig = config && command = restoreを使用します。

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

externalFeedCredentials - このorganization/コレクション外のフィードの資格情報
入力エイリアス: externalEndpoints。 string. 省略可能。 の場合は selectOrConfig = config && command = restoreを使用します。

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

noCache - ローカル キャッシュを無効にする
boolean. 省略可能。 の場合は command = restoreを使用します。 既定値: false。

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

disableParallelProcessing - 並列処理を無効にする
boolean. 省略可能。 の場合は command = restoreを使用します。 既定値: false。

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

restoreDirectory - 宛先ディレクトリ
入力エイリアス: packagesDirectory。 string. 省略可能。 の場合は command = restoreを使用します。

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

verbosityRestore - 詳細
string. 省略可能。 の場合は command = restoreを使用します。 許可値: Quiet、Normal、Detailed。 既定値: Detailed。

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

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

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

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

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

publishVstsFeed - ターゲット フィード
入力エイリアス: 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 、タスクは失敗します。 このオプションは機能せず、プロキシ環境内にある場合、発行は失敗します。

publishFeedCredentials - 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.

configuration - パッケージ化する構成
入力エイリアス: 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-ci-datetime書式設定された SemVer 準拠バージョンが生成されます。ここで、X、Y、Z の値を指定します。
• 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。

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

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

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

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

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

packTimezone - タイム ゾーン
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を使用します。

token=value ペアのリストをセミコロンで区切って指定します。ファイル内の .nuspec の各出現$token$箇所は、指定された値に置き換えられます。 値には、引用符で囲まれた文字列を指定できます。

basePath - ベース パス
string. 省略可能。 の場合は command = packを使用します。

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

verbosityPack - 詳細
string. 省略可能。 の場合は command = packを使用します。 許可値: Quiet、Normal、Detailed。 既定値: Detailed。

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

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

実行のために渡されるコマンドと引数を NuGet.exe 指定します。 NuGet 3.5 以降が使用されている場合、プロジェクト コレクション ビルド サービスがアクセスできるこのorganizationまたはコレクション内のフィードに対して、 などのlistrestorepublish認証済みコマンドが自動的に認証されます。

タスク制御オプション

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

出力変数

[なし] :

解説

重要

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

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

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

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

ヒント

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

バージョン管理スキーム

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

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

byBuildNumber の場合、バージョンはパイプライン実行のビルド番号を使用して設定されます。 これは、パイプラインの name プロパティに指定された値であり、環境変数 BUILD_BUILDNUMBER に保存されます)。 使用されているビルド番号に、 などの 1.0.$(Rev:r)適切な SemVer が含まれていることを確認します。 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@0nuGetRestoreArgs 使用していた場合は、これらも に arguments入ります。

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

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

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

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

例

復元

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

# 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'

Package

宛先フォルダーに 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'
  

Custom

既定 (pack、push、restore) 以外の NuGet コマンドを実行します。

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

要件

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