NuGetCommand@2 - Attività NuGet v2

Usare questa attività per ripristinare, creare pacchetti o eseguire il push di pacchetti NuGet o eseguire un comando NuGet. Questa attività supporta i feed NuGet.org e autenticati come Gli artefatti di Azure e MyGet. Questa attività usa anche NuGet.exe e funziona con le app .NET Framework. Per le app .NET Core e .NET Standard, usare l'attività .NET Core.

Sintassi

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

Input

command - Comando
string. Obbligatorio. Valori consentiti: restore, pack, custompush. Valore predefinito: restore.

Specifica il comando NuGet da eseguire. Usare il custom valore per aggiungere argomenti o per usare un comando diverso.

restoreSolution - Percorso della soluzione, packages.config o project.json
Alias di input: solution. string. Obbligatorio quando command = restore. Valore predefinito: **/*.sln.

Specifica il percorso della soluzione, packages.configo project.json del file che fa riferimento ai pacchetti da ripristinare.

feedsToUse - Feed da usare
Alias di input: selectOrConfig. string. Obbligatorio quando command = restore. Valori consentiti: select (Feed selezionato qui), config (Feed nella mia NuGet.config). Valore predefinito: select.

Specifica un feed da Elementi di Azure e/o NuGet.org per l'attività da usare con il select valore. In alternativa, è possibile eseguire il commit di un NuGet.config file nel repository del codice sorgente e impostarne il percorso come valore usando il config valore.

vstsFeed - Usare i pacchetti da questo feed di Elementi di Azure/TFS
Alias di input: feedRestore. string. facoltativo. Usare quando selectOrConfig = select && command = restore.

Specifica il feed selezionato nell'oggetto generato NuGet.config. È necessario che Gestione pacchetti sia installato e concesso in licenza per specificare un feed qui.

includeNuGetOrg - Usare i pacchetti da NuGet.org
boolean. facoltativo. Usare quando selectOrConfig = select && command = restore. Valore predefinito: true.

Include NuGet.org nell'oggetto generato NuGet.config.

nugetConfigPath - Percorso di NuGet.config
string. facoltativo. Usare quando selectOrConfig = config && command = restore.

Specifica il percorso dell'oggetto NuGet.config nel repository che determina i feed da cui ripristinare i pacchetti.

externalFeedCredentials - Credenziali per i feed all'esterno di questa organizzazione/raccolta
Alias di input: externalEndpoints. string. facoltativo. Usare quando selectOrConfig = config && command = restore.

Specifica le credenziali da usare per i registri esterni che si trovano nell'oggetto selezionato NuGet.config. Si tratta del nome della connessione al servizio NuGet. Per i feed in questa organizzazione o raccolta, lasciare vuoto questo; le credenziali della compilazione vengono usate automaticamente.

noCache - Disabilitare la cache locale
boolean. facoltativo. Usare quando command = restore. Valore predefinito: false.

Impedisce a NuGet di usare i pacchetti dalle cache del computer locale quando è impostato su true.

disableParallelProcessing - Disabilitare l'elaborazione parallela
boolean. facoltativo. Usare quando command = restore. Valore predefinito: false.

Impedisce a NuGet di installare più pacchetti nei processi paralleli quando è impostato su true.

restoreDirectory - Directory di destinazione
Alias di input: packagesDirectory. string. facoltativo. Usare quando command = restore.

Specifica la cartella in cui vengono installati i pacchetti. Se non viene specificata alcuna cartella, i pacchetti vengono ripristinati in una packages/ cartella insieme alla soluzione selezionata, packages.configo project.json.

verbosityRestore - Dettaglio
string. facoltativo. Usare quando command = restore. Valori consentiti: Quiet, Normal, Detailed. Valore predefinito: Detailed.

Specifica la quantità di dettagli visualizzati nell'output.

packagesToPush - Percorso dei pacchetti NuGet da pubblicare
Alias di input: searchPatternPush. string. Obbligatorio quando command = push. Valore predefinito: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.

Specifica il modello da associare o il percorso ai nupkg file da caricare. Più modelli possono essere separati da un punto e virgola.

nuGetFeedType - Percorso feed di destinazione
string. Obbligatorio quando command = push. Valori consentiti: internal (organizzazione/raccolta), external (server NuGet esterno (inclusi altri account/raccolte)). Valore predefinito: internal.

Specifica se il feed di destinazione è un feed/raccolta interno o un server NuGet esterno.

publishVstsFeed - Feed di destinazione
Alias di input: feedPublish. string. Obbligatorio quando command = push && nuGetFeedType = internal.

Specifica un feed ospitato in questo account. Per selezionare un feed, è necessario che Azure Artifacts sia installato e concesso in licenza.

publishPackageMetadata - Pubblicare i metadati della pipeline
boolean. facoltativo. Usare quando command = push && nuGetFeedType = internal && command = push. Valore predefinito: true.

Modifica il numero di versione del subset di pacchetti modificati all'interno di un set di pacchetti pubblicati continuamente.

allowPackageConflicts - Consente di ignorare i duplicati
boolean. facoltativo. Usare quando command = push && nuGetFeedType = internal. Valore predefinito: false.

Segnala l'esito positivo dell'attività anche se alcuni pacchetti vengono rifiutati con errori di conflitto 409.

Questa opzione è attualmente disponibile solo per gli agenti Azure Pipelines e Windows. Se NuGet.exe si verifica un conflitto, l'attività avrà esito negativo. Questa opzione non funzionerà e la pubblicazione avrà esito negativo se si è all'interno di un ambiente proxy.

publishFeedCredentials - Server NuGet
Alias di input: externalEndpoint. string. Obbligatorio quando command = push && nuGetFeedType = external.

Specifica la connessione al servizio NuGet che contiene le credenziali del server NuGet esterno.

verbosityPush - Dettaglio
string. facoltativo. Usare quando command = push. Valori consentiti: Quiet, Normal, Detailed. Valore predefinito: Detailed.

Specifica la quantità di dettagli visualizzati nell'output.

packagesToPack - Percorso dei file csproj o nuspec da comprimere
Alias di input: searchPatternPack. string. Obbligatorio quando command = pack. Valore predefinito: **/*.csproj.

Specifica il modello utilizzato dall'attività per cercare le directory csproj da comprimere.

È possibile separare più modelli con un punto e virgola ed è possibile rendere negativo un criterio anteponendolo a !. Esempio: **\*.csproj;!**\*.Tests.csproj.

configuration - Configurazione da creare nel pacchetto
Alias di input: configurationToPack. string. facoltativo. Usare quando command = pack. Valore predefinito: $(BuildConfiguration).

Specifica la configurazione da creare nel pacchetto quando si usa un file csproj.

packDestination - Cartella del pacchetto
Alias di input: outputDir. string. facoltativo. Usare quando command = pack. Valore predefinito: $(Build.ArtifactStagingDirectory).

Specifica la cartella in cui l'attività crea pacchetti. Se il valore è vuoto, l'attività crea pacchetti nella radice di origine.

versioningScheme - Controllo automatico delle versioni dei pacchetti
string. Obbligatorio quando command = pack. Valori consentiti: off, byPrereleaseNumber (usare la data e l'ora), byEnvVar (Usare una variabile di ambiente), byBuildNumber (Usare il numero di build). Valore predefinito: off.

Applica il controllo delle versioni automatiche dei pacchetti a seconda del valore specificato. Questa stringa non può essere usata con includeReferencedProjects. Di seguito sono elencati i valori consentiti:

• byPrereleaseNumber - Usare la data e l'ora: l'attività genererà una versione conforme a SemVer formattata come X.Y.Z-ci-datetime, in cui si specificano i valori di X, Y e Z.
• byEnvVar- Usare una variabile di ambiente: l'attività userà una variabile di ambiente specificata e contenente il numero di versione che si vuole usare.
• byBuildNumber - Usare il numero di build: l'attività userà il numero di build per la versione del pacchetto.

Nota

In Generale impostare il formato di compilazione su $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

includeReferencedProjects - Includere progetti a cui si fa riferimento
boolean. facoltativo. Usare quando versioningScheme = off && command = pack. Valore predefinito: false.

Include progetti a cui si fa riferimento come dipendenze o come parte del pacchetto. Non è possibile utilizzare con il controllo delle versioni automatiche dei pacchetti. Se un progetto a cui si fa riferimento ha un file corrispondente nuspec con lo stesso nome del progetto, tale progetto di riferimento viene aggiunto come dipendenza. In caso contrario, il progetto a cui si fa riferimento viene aggiunto come parte del pacchetto. Altre informazioni sull'uso del comando pack per l'interfaccia della riga di comando di NuGet per creare pacchetti NuGet.

versionEnvVar - Variabile di ambiente
string. Obbligatorio quando versioningScheme = byEnvVar && command = pack.

Specifica il nome della variabile senza $, $envo %.

majorVersion - Principali
Alias di input: requestedMajorVersion. string. Obbligatorio quando versioningScheme = byPrereleaseNumber && command = pack. Valore predefinito: 1.

Nella X versione X.Y.Z.

minorVersion - Minore
Alias di input: requestedMinorVersion. string. Obbligatorio quando versioningScheme = byPrereleaseNumber && command = pack. Valore predefinito: 0.

Nella Y versione X.Y.Z.

patchVersion - Benda
Alias di input: requestedPatchVersion. string. Obbligatorio quando versioningScheme = byPrereleaseNumber && command = pack. Valore predefinito: 0.

Nella Z versione X.Y.Z.

packTimezone - Fuso orario
string. facoltativo. Usare quando versioningScheme = byPrereleaseNumber && command = pack. Valori consentiti: utc, local (ora locale agente). Valore predefinito: utc.

Specifica il fuso orario desiderato utilizzato per produrre la versione del pacchetto. La selezione utc è consigliata se si usano agenti di compilazione ospitati, in quanto la data e l'ora potrebbero variare.

includeSymbols - Creare un pacchetto di simboli
boolean. facoltativo. Usare quando command = pack. Valore predefinito: false.

Specifica che il pacchetto contiene origini e simboli. Se usato con un .nuspec file, viene creato un normale file di pacchetto NuGet e il pacchetto di simboli corrispondente.

toolPackage - Pacchetto degli strumenti
boolean. facoltativo. Usare quando command = pack. Valore predefinito: false.

Determina se i file di output del progetto devono trovarsi nella cartella dello strumento.

buildProperties - Proprietà di compilazione aggiuntive
string. facoltativo. Usare quando command = pack.

Specifica un elenco di coppie token=value, separate da punti e virgola, dove ogni occorrenza del $token$.nuspec file verrà sostituita con il valore specificato. I valori possono essere stringhe tra virgolette.

basePath - Percorso di base
string. facoltativo. Usare quando command = pack.

Specifica il percorso di base dei file definiti nel nuspec file.

verbosityPack - Dettaglio
string. facoltativo. Usare quando command = pack. Valori consentiti: Quiet, Normal, Detailed. Valore predefinito: Detailed.

Specifica la quantità di dettagli visualizzati nell'output.

arguments - Comandi e argomenti
string. Obbligatorio quando command = custom.

Specifica il comando e gli argomenti che verranno passati a NuGet.exe per l'esecuzione. Se viene usato NuGet 3.5 o versioni successive, i comandi autenticati come list, restoree publish su qualsiasi feed in questa organizzazione o raccolta a cui il servizio Compilazione raccolta project ha accesso verrà autenticato automaticamente.

Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

Importante

L'attività NuGet Authentication è il nuovo modo consigliato per eseguire l'autenticazione con Gli artefatti di Azure e altri repository NuGet. Questa attività non accetta più nuove funzionalità e vengono risolti solo bug critici.

Usare questa attività per installare e aggiornare le dipendenze del pacchetto NuGet o il pacchetto e pubblicare pacchetti NuGet. Usa NuGet.exe e funziona con le app .NET Framework. Per le app .NET Core e .NET Standard, usare l'attività .NET Core.

Se il codice dipende dai pacchetti NuGet, assicurarsi di aggiungere questo passaggio prima dell'attività di compilazione di Visual Studio. Assicurarsi inoltre di cancellare la casella di controllo Ripristina pacchetti NuGet deprecati in tale attività.

Se si usa .NET Core o .NET Standard, usare l'attività .NET Core , che include il supporto completo per tutti gli scenari del pacchetto ed è attualmente supportato da dotnet.

Suggerimento

Questa versione dell'attività NuGet usa NuGet 4.1.0 per impostazione predefinita. Per selezionare una versione diversa di NuGet, usare il programma di installazione degli strumenti.

Schemi di controllo delle versioni

Per byPrereleaseNumber, la versione verrà impostata sui valori scelti per la versione principale, la versione secondaria e la patch, oltre alla data e all'ora, nel formato yyyymmdd-hhmmss.

Per byEnvVar, la versione verrà impostata sul valore della variabile di ambiente con il nome specificato dal parametro versionEnvVar , ad esempio MyVersion (no $, solo il nome della variabile di ambiente). Assicurarsi che la variabile di ambiente sia impostata su un semVer appropriato, ad esempio 1.2.3 o 1.2.3-beta1.

Per byBuildNumber, la versione verrà impostata usando il numero di compilazione dell'esecuzione della pipeline. Questo è il valore specificato per la proprietà della pipeline, che viene salvata nella BUILD_BUILDNUMBER variabile di name ambiente. Assicurarsi che il numero di compilazione usato contenga un semVer appropriato, ad esempio 1.0.$(Rev:r). Quando si usa byBuildNumber, l'attività estrae la versione punteggiata, , 1.2.3.4dalla stringa del numero di compilazione e usa solo tale parte. Il resto della stringa verrà eliminato. Se si vuole usare il numero di compilazione come è, è possibile usare byEnvVar come descritto in precedenza e impostare versionEnvVar su BUILD_BUILDNUMBER.

Eseguire la migrazione da NuGetInstaller@0 o NuGetRestore@1

NuGetInstaller@0 e sono deprecati e NuGetRestore@1 è necessario sostituirli nella pipeline con NuGetCommand@2.

Se si usa con , configurare gli input seguenti quando si usa NuGetInstaller@0NuGetCommand@2.restoreMode: restore

input attività NuGetCommand@2	Valore
command	restore
restoreSolution	Percorso del file .sln

Se si usa con , configurare gli input seguenti quando si usa NuGetInstaller@0NuGetCommand@2.restoreMode: install

input attività NuGetCommand@2	Valore
command	custom
arguments	Quale comando di installazione completo sarà simile all'interfaccia della riga di comando di NuGet. Ad esempio, se si vuole eseguire l'equivalente di nuget install ninject -OutputDirectory c:\proj nella pipeline, il arguments parametro sarà install ninject -OutputDirectory c:\proj. Se si usa il NuGetInstaller@0nuGetRestoreArgs parametro, questi sono ora disponibili anche in arguments.

Se si usa , configurare gli input seguenti quando si usa NuGetRestore@1NuGetCommand@2.

input attività NuGetCommand@2	Valore
command	restore
restoreSolution	Percorso del file .sln

Analogamente all'uso NuGetRestore@1 o all'opzione NuGetInstaller@0restore , NuGetCommand@2 include input per impostare il feed, decidere tra select o config, specificare il percorso del NuGet.config file e usare i pacchetti da nuget.org.

Per altre informazioni, vedere gli esempi seguenti.

Esempio

Restore

Ripristinare tutte le soluzioni con pacchetti da un feed selezionato.

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

Pacchetto

Creare un pacchetto NuGet nella cartella di destinazione.

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

Push

Nota

Gli artefatti della pipeline vengono scaricati nella Pipeline.Workspace directory e nella System.ArtifactsDirectory directory per le pipeline di rilascio classiche. packagesToPush il valore può essere impostato rispettivamente su $(Pipeline.Workspace)/**/*.nupkg o $(System.ArtifactsDirectory)/**/*.nupkg .

• Eseguire il push/pubblicazione di un pacchetto in un feed definito nel NuGet.config.

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

• Eseguire il push/pubblicazione di un pacchetto in un feed con ambito organizzazione

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

• Eseguire il push/pubblicazione di un pacchetto in un feed con ambito progetto

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

• Eseguire il push/pubblicazione di un pacchetto in NuGet.org

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

Personalizzato

Eseguire qualsiasi altro comando NuGet oltre a quelli predefiniti: pack, push e ripristino.

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

Requisiti

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Esecuzione in	Agente, DeploymentGroup
Richieste	Nessuno
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	2.144.0 o versione successiva
Categoria attività	Pacchetto