NuGetCommand@2 – NuGet v2-uppgift

Använd den här uppgiften för att återställa, packa eller push-överföra NuGet-paket eller köra ett NuGet-kommando. Den här uppgiften stöder NuGet.org och autentiserade feeds som Azure Artifacts och MyGet. Den här uppgiften använder också NuGet.exe och fungerar med .NET Framework-appar. För .NET Core- och .NET Standard-appar använder du .NET Core-uppgiften.

Syntax

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

Ingångar

command - kommando
string. Krävs. Tillåtna värden: restore, pack, push, custom. Standardvärde: restore.

Anger det NuGet-kommando som ska köras. Använd värdet custom för att lägga till argument eller för att använda ett annat kommando.

restoreSolution - Sökväg till lösning, packages.configeller project.json
Indataalias: solution. string. Krävs när command = restore. Standardvärde: **/*.sln.

Anger sökvägen till lösningen, packages.configeller project.json fil som refererar till de paket som ska återställas.

feedsToUse - feeds för att använda
Indataalias: selectOrConfig. string. Krävs när command = restore. Tillåtna värden: select (feeds) som jag väljer här), config (feeds i min NuGet.config). Standardvärde: select.

Anger ett flöde från Azure Artifacts och/eller NuGet.org för uppgiften som ska användas med värdet select. Du kan också checka in en NuGet.config fil till källkodslagringsplatsen och ange dess sökväg som värdet med hjälp av config-värdet.

vstsFeed - Använd paket från den här Azure Artifacts/TFS-feeden. Välj i listrutan eller ange [projektnamn/]feednamn.
Indataalias: feedRestore. string. Valfri. Använd när selectOrConfig = select && command = restore.

Anger den valda feeden i den genererade NuGet.config. Du måste ha Pakethantering installerat och licensierat för att kunna ange en feed här.

includeNuGetOrg - Använd paket från NuGet.org
boolean. Valfri. Använd när selectOrConfig = select && command = restore. Standardvärde: true.

Innehåller NuGet.org i den genererade NuGet.config.

nugetConfigPath - sökväg till NuGet.config
string. Valfri. Använd när selectOrConfig = config && command = restore.

Anger sökvägen till NuGet.config på lagringsplatsen som avgör vilka feeds som paketen ska återställas från.

externalFeedCredentials - Autentiseringsuppgifter för feeds utanför organisationen/samlingen
Indataalias: externalEndpoints. string. Valfri. Använd när selectOrConfig = config && command = restore.

Anger de autentiseringsuppgifter som ska användas för externa register som finns i den valda NuGet.config. Det här är namnet på din NuGet-tjänstanslutning. Lämna detta tomt för feeds i den här organisationen eller samlingen. byggets autentiseringsuppgifter används automatiskt.

noCache - Inaktivera lokal cache
boolean. Valfri. Använd när command = restore. Standardvärde: false.

Hindrar NuGet från att använda paket från lokala datorcacheminnen när det är inställt på true.

disableParallelProcessing - Inaktivera parallell bearbetning
boolean. Valfri. Använd när command = restore. Standardvärde: false.

Hindrar NuGet från att installera flera paket i parallella processer när det är inställt på true.

restoreDirectory - Målkatalog
Indataalias: packagesDirectory. string. Valfri. Använd när command = restore.

Anger mappen där paket installeras. Om ingen mapp anges återställs paketen till en packages/ mapp tillsammans med den valda lösningen, packages.configeller project.json.

verbosityRestore - utförlighet
string. Valfri. Använd när command = restore. Tillåtna värden: Quiet, Normal, Detailed. Standardvärde: Detailed.

Anger mängden information som visas i utdata.

packagesToPush - sökväg till NuGet-paket för att publicera
Indataalias: searchPatternPush. string. Krävs när command = push. Standardvärde: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.

Anger det mönster som ska matchas eller sökvägen till nupkg filer som ska laddas upp. Flera mönster kan avgränsas med ett semikolon.

nuGetFeedType - Målflödesplats
string. Krävs när command = push. Tillåtna värden: internal (den här organisationen/samlingen), external (extern NuGet-server (inklusive andra konton/samlingar)). Standardvärde: internal.

Anger om målflödet är en intern feed/samling eller en extern NuGet-server.

publishVstsFeed - Målflöde
Indataalias: feedPublish. string. Krävs när command = push && nuGetFeedType = internal.

Anger ett flöde som finns i det här kontot. Du måste ha Azure Artifacts installerat och licensierat för att välja en feed här.

publishPackageMetadata - Publicera pipelinemetadata
boolean. Valfri. Använd när command = push && nuGetFeedType = internal && command = push. Standardvärde: true.

Ändrar versionsnumret för delmängden av ändrade paket i en uppsättning kontinuerligt publicerade paket.

allowPackageConflicts - Tillåt att dubbletter hoppas över
boolean. Valfri. Använd när command = push && nuGetFeedType = internal. Standardvärde: false.

Rapporterar aktivitetsframgång även om vissa av paketen avvisas med 409 Konfliktfel.

Det här alternativet är för närvarande endast tillgängligt för Azure Pipelines- och Windows-agenter. Om NuGet.exe stöter på en konflikt misslyckas uppgiften. Det här alternativet fungerar inte och publiceringen misslyckas om du befinner dig i en proxymiljö.

publishFeedCredentials - NuGet-server
Indataalias: externalEndpoint. string. Krävs när command = push && nuGetFeedType = external.

Anger NuGet-tjänstanslutningen som innehåller den externa NuGet-serverns autentiseringsuppgifter.

verbosityPush - utförlighet
string. Valfri. Använd när command = push. Tillåtna värden: Quiet, Normal, Detailed. Standardvärde: Detailed.

Anger mängden information som visas i utdata.

packagesToPack - Sökväg till csproj- eller nuspec-filer för att packa
Indataalias: searchPatternPack. string. Krävs när command = pack. Standardvärde: **/*.csproj.

Anger det mönster som aktiviteten använder för att söka efter csproj-kataloger som ska packas.

Du kan separera flera mönster med ett semikolon och du kan göra ett mönster negativt genom att prefixera det med !. Exempel: **\*.csproj;!**\*.Tests.csproj.

configuration - Konfiguration för att paketera
Indataalias: configurationToPack. string. Valfri. Använd när command = pack. Standardvärde: $(BuildConfiguration).

Anger vilken konfiguration som ska paketeras när du använder en csproj-fil.

packDestination - -paketmappen
Indataalias: outputDir. string. Valfri. Använd när command = pack. Standardvärde: $(Build.ArtifactStagingDirectory).

Anger mappen där uppgiften skapar paket. Om värdet är tomt skapar aktiviteten paket i källroten.

versioningScheme - Automatisk versionshantering av paket
string. Krävs när command = pack. Tillåtna värden: off, byPrereleaseNumber (Använd datum och tid), byEnvVar (Använd en miljövariabel), byBuildNumber (Använd versionsnumret). Standardvärde: off.

Tillämpar automatisk paketversionshantering beroende på det angivna värdet. Det går inte att använda den här strängen med includeReferencedProjects. De tillåtna värdena är:

• byPrereleaseNumber - Använd datum och tid: Uppgiften genererar en SemVer-kompatibel version formaterad som X.Y.Z-ci-datetime, där du anger värdena för X, Y och Z.
• byEnvVar - Använd en miljövariabel: Uppgiften använder en miljövariabel som du anger och innehåller det versionsnummer som du vill använda.
• byBuildNumber - Använd versionsnumret: Uppgiften använder versionsnumret för paketet.

Not

Under Allmänt anger du byggformatet till $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

includeReferencedProjects - Inkludera refererade projekt
boolean. Valfri. Använd när versioningScheme = off && command = pack. Standardvärde: false.

Innehåller refererade projekt antingen som beroenden eller som en del av paketet. Det går inte att använda med automatisk paketversionshantering. Om ett refererat projekt har en motsvarande nuspec fil som har samma namn som projektet läggs det refererade projektet till som ett beroende. Annars läggs det refererade projektet till som en del av paketet. Läs mer om med hjälp av paketkommandot för NuGet CLI för att skapa NuGet-paket.

versionEnvVar - Miljövariabel
string. Krävs när versioningScheme = byEnvVar && command = pack.

Anger variabelnamnet utan $, $enveller %.

majorVersion - större
Indataalias: requestedMajorVersion. string. Krävs när versioningScheme = byPrereleaseNumber && command = pack. Standardvärde: 1.

X i version X.Y.Z.

minorVersion - mindre
Indataalias: requestedMinorVersion. string. Krävs när versioningScheme = byPrereleaseNumber && command = pack. Standardvärde: 0.

Y i version X.Y.Z.

patchVersion - Patch
Indataalias: requestedPatchVersion. string. Krävs när versioningScheme = byPrereleaseNumber && command = pack. Standardvärde: 0.

Z i version X.Y.Z.

packTimezone - Tidszon
string. Valfri. Använd när versioningScheme = byPrereleaseNumber && command = pack. Tillåtna värden: utc, local (lokal agenttid). Standardvärde: utc.

Anger önskad tidszon som används för att skapa versionen av paketet. Du bör välja utc om du använder värdbaserade byggagenter eftersom datum och tid kan skilja sig åt.

includeSymbols - Skapa symbolpaket
boolean. Valfri. Använd när command = pack. Standardvärde: false.

Anger att paketet innehåller källor och symboler. När den används med en .nuspec fil skapas en vanlig NuGet-paketfil och motsvarande symbolpaket.

toolPackage - Verktygspaket
boolean. Valfri. Använd när command = pack. Standardvärde: false.

Avgör om utdatafilerna för projektet ska finnas i verktygsmappen.

buildProperties - Ytterligare byggegenskaper
string. Valfri. Använd när command = pack.

Anger en lista över token=värdepar, avgränsade med semikolon, där varje förekomst av $token$ i .nuspec-filen ersätts med det angivna värdet. Värden kan vara strängar inom citattecken.

basePath - bassökväg
string. Valfri. Använd när command = pack.

Anger bassökvägen för de filer som definierats i nuspec-filen.

verbosityPack - utförlighet
string. Valfri. Använd när command = pack. Tillåtna värden: Quiet, Normal, Detailed. Standardvärde: Detailed.

Anger mängden information som visas i utdata.

arguments - kommando och argument
string. Krävs när command = custom.

Anger kommandot och argumenten som ska skickas till NuGet.exe för körning. Om NuGet 3.5 eller senare används autentiserade kommandon som list, restoreoch publish mot alla feeds i den här organisationen eller samlingen som Project Collection Build Service har åtkomst till autentiseras automatiskt.

Alternativ för aktivitetskontroll

Alla aktiviteter har kontrollalternativ utöver sina uppgiftsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Ingen.

Anmärkningar

Viktig

Uppgiften NuGet Authenticate är det nya rekommenderade sättet att autentisera med Azure Artifacts och andra NuGet-lagringsplatser. Den här uppgiften tar inte längre nya funktioner och endast kritiska buggar åtgärdas.

Använd den här uppgiften för att installera och uppdatera NuGet-paketberoenden eller paketera och publicera NuGet-paket. Använder NuGet.exe och fungerar med .NET Framework-appar. För .NET Core- och .NET Standard-appar använder du .NET Core-uppgiften.

Om koden är beroende av NuGet-paket måste du lägga till det här steget innan du Visual Studio Build-uppgift. Se också till att avmarkera kryssrutan Föråldrade Återställ NuGet-paket i den uppgiften.

Om du arbetar med .NET Core eller .NET Standard använder du uppgiften .NET Core, som har fullt stöd för alla paketscenarier och som för närvarande stöds av dotnet.

Dricks

Den här versionen av NuGet-aktiviteten använder NuGet 4.1.0 som standard. Om du vill välja en annan version av NuGet använder du Tool Installer.

Versionsscheman

För byPrereleaseNumberanges versionen till de värden som du väljer för huvudversionen, delversionen och korrigeringen, plus datum och tid, i formatet yyyymmdd-hhmmss.

För avEnvVaranges versionen till värdet för miljövariabeln som har namnet som anges av parametern versionEnvVar, t.ex. MyVersion (ingen $, bara miljövariabelns namn). Kontrollera att miljövariabeln är inställd på en korrekt SemVer, till exempel 1.2.3 eller 1.2.3-beta1.

För byBuildNumberanges versionen med pipelinekörningens versionsnummer. Det här är det värde som anges för pipelinens name egenskap, som sparas i BUILD_BUILDNUMBER miljövariabeln). Kontrollera att versionsnumret som används innehåller en korrekt SemVer, till exempel 1.0.$(Rev:r). När du använder byBuildNumberextraherar aktiviteten den streckade versionen, 1.2.3.4, från versionsnummersträngen och använder endast den delen. Resten av strängen tas bort. Om du vill använda versionsnumret som det är kan du använda byEnvVar enligt beskrivningen ovan och ange versionEnvVar till BUILD_BUILDNUMBER.

Migrera från NuGetInstaller@0 eller NuGetRestore@1

NuGetInstaller@0 och NuGetRestore@1 är inaktuella och du bör ersätta dem i pipelinen med NuGetCommand@2.

Om du använde NuGetInstaller@0 med restoreMode: restorekonfigurerar du följande indata när du använder NuGetCommand@2.

NuGetCommand@2 aktivitetsindata	Värde
command	restore
restoreSolution	Sök efter .sln-filen

Om du använde NuGetInstaller@0 med restoreMode: installkonfigurerar du följande indata när du använder NuGetCommand@2.

NuGetCommand@2 aktivitetsindata	Värde
command	custom
arguments	Hur det fullständiga installationskommandot skulle se ut i NuGet CLI. Om du till exempel vill köra motsvarande nuget install ninject -OutputDirectory c:\proj i pipelinen är parametern argumentsinstall ninject -OutputDirectory c:\proj. Om du använder parametern NuGetInstaller@0nuGetRestoreArgs går dessa nu också in arguments.

Om du använde NuGetRestore@1konfigurerar du följande indata när du använder NuGetCommand@2.

NuGetCommand@2 aktivitetsindata	Värde
command	restore
restoreSolution	Sök efter .sln-filen

På samma sätt som med alternativet NuGetRestore@1 eller NuGetInstaller@0restore har NuGetCommand@2 indata för att ange feeden, bestämma mellan select eller config, ange sökvägen till filen NuGet.config och använda paket från nuget.org.

Mer information finns i följande exempel.

Exempel

Återställa

Återställ alla dina lösningar med paket från en vald feed.

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

Paket

Skapa ett NuGet-paket i målmappen.

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

Trycka

Not

Pipelineartefakter laddas ned till katalogen Pipeline.Workspace och till katalogen System.ArtifactsDirectory för klassiska versionspipelines. packagesToPush värde kan anges till $(Pipeline.Workspace)/**/*.nupkg respektive $(System.ArtifactsDirectory)/**/*.nupkg.

• Skicka/publicera ett paket till en feed som definierats i din NuGet.config.

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

• Skicka/publicera ett paket till ett flöde med organisationsomfattning

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

• Skicka/publicera ett paket till ett projektomfångsflöde

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

• Skicka/publicera ett paket till NuGet.org

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

Sed

Kör alla andra NuGet-kommandon förutom standardkommandona: pack, push och restore.

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

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
kräver	Ingen
funktioner	Den här aktiviteten uppfyller inte några krav på efterföljande uppgifter i jobbet.
Kommandobegränsningar	Någon
variabler som kan	Någon
Agentversion	2.144.0 eller senare
Aktivitetskategori	Paket