tarefa NuGetCommand@2 - NuGet v2

Use essa tarefa para restaurar, empacotar ou enviar pacotes NuGet por push ou executar um comando NuGet. Essa tarefa dá suporte a feeds NuGet.org e autenticados, como o Azure Artifacts e o MyGet. Essa tarefa também usa NuGet.exe e funciona com aplicativos .NET Framework. Para aplicativos .NET Core e .NET Standard, use a tarefa .NET Core.

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

Entradas

command - Comando
string. Obrigatórios. Valores permitidos: restore, pack, , push. custom Valor padrão: restore.

Especifica o comando NuGet a ser executado. Use o custom valor para adicionar argumentos ou para usar um comando diferente.

restoreSolution - Caminho para solução, packages.config ou project.json
Alias de entrada: solution. string. Obrigatório quando command = restore. Valor padrão: **/*.sln.

Especifica o caminho para a solução, packages.configou project.json arquivo que faz referência aos pacotes a serem restaurados.

feedsToUse - Feeds a serem usados
Alias de entrada: selectOrConfig. string. Obrigatório quando command = restore. Valores permitidos: select (Feed(s) eu seleciono aqui) config (Feeds no meu NuGet.config). Valor padrão: select.

Especifica um feed do Azure Artifacts e/ou NuGet.org para a tarefa a ser usada com o select valor . Como alternativa, você pode confirmar um NuGet.config arquivo no repositório de código-fonte e definir seu caminho como o valor usando o config valor .

vstsFeed - Usar pacotes deste feed do Azure Artifacts/TFS
Alias de entrada: feedRestore. string. Opcional. Use quando selectOrConfig = select && command = restore.

Especifica o feed selecionado no gerado NuGet.config. Você deve ter o Gerenciamento de Pacotes instalado e licenciado para especificar um feed aqui.

includeNuGetOrg - Usar pacotes de NuGet.org
boolean. Opcional. Use quando selectOrConfig = select && command = restore. Valor padrão: true.

Inclui NuGet.org no gerado NuGet.config.

nugetConfigPath - Caminho para NuGet.config
string. Opcional. Use quando selectOrConfig = config && command = restore.

Especifica o caminho para o NuGet.config em seu repositório que determina os feeds dos quais restaurar pacotes.

externalFeedCredentials - Credenciais para feeds fora desta organização/coleção
Alias de entrada: externalEndpoints. string. Opcional. Use quando selectOrConfig = config && command = restore.

Especifica as credenciais a serem usadas para registros externos localizados no selecionado NuGet.config. Esse é o nome da conexão de serviço do NuGet. Para feeds nesta organização ou coleção, deixe isso em branco; As credenciais do build são usadas automaticamente.

noCache - Desabilitar o cache local
boolean. Opcional. Use quando command = restore. Valor padrão: false.

Impede que o NuGet use pacotes de caches de computador locais quando definido como true.

disableParallelProcessing - Desabilitar o processamento paralelo
boolean. Opcional. Use quando command = restore. Valor padrão: false.

Impede que o NuGet instale vários pacotes em processos paralelos quando definido como true.

restoreDirectory - Diretório de destino
Alias de entrada: packagesDirectory. string. Opcional. Use quando command = restore.

Especifica a pasta na qual os pacotes estão instalados. Se nenhuma pasta for especificada, os pacotes serão restaurados em uma packages/ pasta junto com a solução selecionada, packages.configou project.json.

verbosityRestore - Verbosidade
string. Opcional. Use quando command = restore. Valores permitidos: Quiet, Normal, Detailed. Valor padrão: Detailed.

Especifica a quantidade de detalhes exibidos na saída.

packagesToPush - Caminho para pacotes NuGet a serem publicados
Alias de entrada: searchPatternPush. string. Obrigatório quando command = push. Valor padrão: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.

Especifica o padrão a ser correspondido ou o caminho para nupkg os arquivos a serem carregados. Vários padrões podem ser separados por ponto e vírgula.

nuGetFeedType - Local do feed de destino
string. Obrigatório quando command = push. Valores permitidos: internal (esta organização/coleção), external (servidor NuGet externo (incluindo outras contas/coleções)). Valor padrão: internal.

Especifica se o feed de destino é um feed/coleção interno ou um servidor NuGet externo.

publishVstsFeed - Feed de destino
Alias de entrada: feedPublish. string. Obrigatório quando command = push && nuGetFeedType = internal.

Especifica um feed hospedado nesta conta. Você deve ter o Azure Artifacts instalado e licenciado para selecionar um feed aqui.

publishPackageMetadata - Publicar metadados de pipeline
boolean. Opcional. Use quando command = push && nuGetFeedType = internal && command = push. Valor padrão: true.

Altera o número de versão do subconjunto de pacotes alterados em um conjunto de pacotes publicados continuamente.

allowPackageConflicts - Permitir que duplicatas sejam ignoradas
boolean. Opcional. Use quando command = push && nuGetFeedType = internal. Valor padrão: false.

Relata o sucesso da tarefa mesmo que alguns de seus pacotes sejam rejeitados com 409 erros de conflito.

No momento, essa opção só está disponível em agentes do Azure Pipelines e do Windows. Se NuGet.exe encontrar um conflito, a tarefa falhará. Essa opção não funcionará e a publicação falhará se você estiver dentro de um ambiente de proxy.

publishFeedCredentials - Servidor NuGet
Alias de entrada: externalEndpoint. string. Obrigatório quando command = push && nuGetFeedType = external.

Especifica a conexão de serviço NuGet que contém as credenciais do servidor NuGet externo.

verbosityPush - Verbosidade
string. Opcional. Use quando command = push. Valores permitidos: Quiet, Normal, Detailed. Valor padrão: Detailed.

Especifica a quantidade de detalhes exibidos na saída.

packagesToPack - Caminho para csproj ou arquivos nuspec para empacotar
Alias de entrada: searchPatternPack. string. Obrigatório quando command = pack. Valor padrão: **/*.csproj.

Especifica o padrão que a tarefa usa para pesquisar diretórios csproj para empacotar.

Você pode separar vários padrões com um ponto e vírgula e você pode tornar o padrão negativo prefixando-o com !. Exemplo: **\*.csproj;!**\*.Tests.csproj.

configuration - Configuração para empacotamento
Alias de entrada: configurationToPack. string. Opcional. Use quando command = pack. Valor padrão: $(BuildConfiguration).

Especifica a configuração a ser empacotada ao usar um arquivo csproj.

packDestination - Pasta de pacote
Alias de entrada: outputDir. string. Opcional. Use quando command = pack. Valor padrão: $(Build.ArtifactStagingDirectory).

Especifica a pasta em que a tarefa cria pacotes. Se o valor estiver vazio, a tarefa criará pacotes na raiz de origem.

versioningScheme - Controle de versão automático do pacote
string. Obrigatório quando command = pack. Valores permitidos: off, byPrereleaseNumber (Use a data e a hora) byEnvVar (Usar uma variável de ambiente) byBuildNumber (Use o número de build). Valor padrão: off.

Aplica o controle de versão automático do pacote dependendo do valor especificado. Essa cadeia de caracteres não pode ser usada com includeReferencedProjects. Os valores permitidos são:

• byPrereleaseNumber - Use a data e a hora: a tarefa gerará uma versão em conformidade com SemVer formatada como X.Y.Z-ci-datetime, em que você especificará os valores de X, Y e Z.
• byEnvVar- Usar uma variável de ambiente: a tarefa usará uma variável de ambiente que você especificar e conterá o número de versão que você deseja usar.
• byBuildNumber - Use o número de build: a tarefa usará o número de build para versão do pacote.

Observação

Em Geral, defina o formato de build como $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

includeReferencedProjects - Incluir projetos referenciados
boolean. Opcional. Use quando versioningScheme = off && command = pack. Valor padrão: false.

Inclui projetos referenciados como dependências ou como parte do pacote. Não é possível usar o controle de versão automático do pacote. Se um projeto referenciado tiver um arquivo correspondente nuspec que tenha o mesmo nome que o projeto, esse projeto referenciado será adicionado como uma dependência. Caso contrário, o projeto referenciado será adicionado como parte do pacote. Saiba mais sobre como usar o comando pack da CLI do NuGet para criar pacotes NuGet.

versionEnvVar - Variável de ambiente
string. Obrigatório quando versioningScheme = byEnvVar && command = pack.

Especifica o nome da variável sem $, $envou %.

majorVersion - Principais
Alias de entrada: requestedMajorVersion. string. Obrigatório quando versioningScheme = byPrereleaseNumber && command = pack. Valor padrão: 1.

O X na versão X.Y.Z.

minorVersion - Menor
Alias de entrada: requestedMinorVersion. string. Obrigatório quando versioningScheme = byPrereleaseNumber && command = pack. Valor padrão: 0.

O Y na versão X.Y.Z.

patchVersion - Patch
Alias de entrada: requestedPatchVersion. string. Obrigatório quando versioningScheme = byPrereleaseNumber && command = pack. Valor padrão: 0.

O Z na versão X.Y.Z.

packTimezone - Fuso horário
string. Opcional. Use quando versioningScheme = byPrereleaseNumber && command = pack. Valores permitidos: utc, local (hora local do agente). Valor padrão: utc.

Especifica o fuso horário desejado usado para produzir a versão do pacote. A seleção utc é recomendada se você estiver usando agentes de build hospedados, pois sua data e hora podem ser diferentes.

includeSymbols - Criar pacote de símbolos
boolean. Opcional. Use quando command = pack. Valor padrão: false.

Especifica que o pacote contém fontes e símbolos. Quando usado com um .nuspec arquivo, isso cria um arquivo de pacote NuGet regular e o pacote de símbolos correspondente.

toolPackage - Pacote de Ferramentas
boolean. Opcional. Use quando command = pack. Valor padrão: false.

Determina se os arquivos de saída do projeto devem ficar na pasta da ferramenta.

buildProperties - Propriedades de build adicionais
string. Opcional. Use quando command = pack.

Especifica uma lista de pares token=value, separados por ponto e vírgula, em que cada ocorrência de $token$ no .nuspec arquivo será substituída pelo valor fornecido. Os valores podem ser cadeias de caracteres entre aspas.

basePath - Caminho base
string. Opcional. Use quando command = pack.

Especifica o caminho base dos arquivos definidos no nuspec arquivo.

verbosityPack - Verbosidade
string. Opcional. Use quando command = pack. Valores permitidos: Quiet, Normal, Detailed. Valor padrão: Detailed.

Especifica a quantidade de detalhes exibidos na saída.

arguments - Comando e argumentos
string. Obrigatório quando command = custom.

Especifica o comando e os argumentos que serão passados para NuGet.exe para execução. Se o NuGet 3.5 ou posterior for usado, comandos autenticados como list, restoree publish em qualquer feed nesta organização ou coleção ao qual o Serviço de Build de Coleção de Projetos tem acesso serão autenticados automaticamente.

Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Importante

A tarefa Autenticação do NuGet é a nova maneira recomendada de autenticar com o Azure Artifacts e outros repositórios NuGet. Essa tarefa não usa mais novos recursos e apenas bugs críticos são resolvidos.

Use essa tarefa para instalar e atualizar dependências de pacote NuGet ou empacotar e publicar pacotes NuGet. Usa o NuGet.exe e funciona com aplicativos .NET Framework. Para aplicativos .NET Core e .NET Standard, use a tarefa .NET Core.

Se o código depender de pacotes NuGet, adicione essa etapa antes da tarefa compilar do Visual Studio. Além disso, desmarque a caixa de seleção Restaurar Pacotes NuGet preteridos nessa tarefa.

Se você estiver trabalhando com o .NET Core ou o .NET Standard, use a tarefa .NET Core , que tem suporte total para todos os cenários de pacote e atualmente tem suporte do dotnet.

Dica

Essa versão da tarefa NuGet usa o NuGet 4.1.0 por padrão. Para selecionar uma versão diferente do NuGet, use o Instalador de Ferramentas.

Esquemas de controle de versão

Para byPrereleaseNumber, a versão será definida com os valores escolhidos para a versão principal, a versão secundária e o patch, além da data e hora, no formato yyyymmdd-hhmmss.

Para byEnvVar, a versão será definida como o valor da variável de ambiente que tem o nome especificado pelo parâmetro versionEnvVar, por exemplo MyVersion, (não $, apenas o nome da variável de ambiente). Verifique se a variável de ambiente está definida como um SemVer adequado, como 1.2.3 ou 1.2.3-beta1.

Para byBuildNumber, a versão será definida usando o número de build da execução do pipeline. Esse é o valor especificado para a propriedade name do pipeline, que é salva na variável de ambiente BUILD_BUILDNUMBER). Verifique se o número de build que está sendo usado contém um SemVer adequado, como 1.0.$(Rev:r). Ao usar byBuildNumber, a tarefa extrairá a versão pontilhada, 1.2.3.4, da cadeia de caracteres de número de build e usará apenas essa parte. O restante da cadeia de caracteres será descartado. Se você quiser usar o número de build como está, poderá usar byEnvVar conforme descrito acima e definir versionEnvVar como BUILD_BUILDNUMBER.

Migrar de NuGetInstaller@0 ou NuGetRestore@1

NuGetInstaller@0 e NuGetRestore@1 são preteridos, e você deve substituí-los em seu pipeline por NuGetCommand@2.

Se você estiver usando NuGetInstaller@0 com restoreMode: restore, configure as seguintes entradas ao usar NuGetCommand@2.

NuGetCommand@2 entrada de tarefa	Valor
command	restore
restoreSolution	Caminho do arquivo .sln

Se você estiver usando NuGetInstaller@0 com restoreMode: install, configure as seguintes entradas ao usar NuGetCommand@2.

NuGetCommand@2 entrada de tarefa	Valor
command	custom
arguments	Como seria a aparência do comando de instalação completa na CLI do NuGet. Por exemplo, se você quiser executar o equivalente de nuget install ninject -OutputDirectory c:\proj em seu pipeline, o arguments parâmetro será install ninject -OutputDirectory c:\proj. Se você estivesse usando o NuGetInstaller@0nuGetRestoreArgs parâmetro , eles também agora entrarão em arguments.

Se você estiver usando NuGetRestore@1, configure as entradas a seguir ao usar NuGetCommand@2.

NuGetCommand@2 entrada de tarefa	Valor
command	restore
restoreSolution	Caminho do arquivo .sln

Semelhante ao uso NuGetRestore@1 ou à opção NuGetInstaller@0restore , NuGetCommand@2 tem entradas para definir o feed, decidir entre select ou config, especificar o caminho para o NuGet.config arquivo e usar pacotes de nuget.org.

Para obter mais informações, consulte os exemplos a seguir.

Exemplos

Restaurar

Restaure todas as suas soluções com pacotes de um feed selecionado.

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

Pacote

Crie um pacote NuGet na pasta de destino.

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

Push

Observação

Os artefatos de pipeline são baixados para o diretório Pipeline.Workspace e para o diretório System.ArtifactsDirectory para pipelines de lançamento clássicos. O valor packagesToPush pode ser definido como $(Pipeline.Workspace)/**/*.nupkg ou $(System.ArtifactsDirectory)/**/*.nupkg, respectivamente.

• Efetue push/publique um pacote em um feed definido em seu NuGet.config.

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

• Enviar por push/publicar um pacote em um feed com escopo de organização

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

• Enviar por push/publicar um pacote em um feed com escopo de projeto

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

• Enviar por push/publicar um pacote para NuGet.org

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

Personalizado

Execute qualquer outro comando do NuGet além dos padrões: pack, push e restore.

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

Requisitos

Requisito	Descrição
Tipos de pipeline	YAML, build clássico, versão clássica
É executado em	Agent, DeploymentGroup
Demandas	Nenhum
Funcionalidades	Essa tarefa não atende a nenhuma demanda por tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	2.144.0 ou superior
Categoria da tarefa	Pacote