NuGetCommand@2: tarea NuGet v2

Use esta tarea para restaurar, empaquetar o insertar paquetes NuGet o ejecutar un comando nuGet. Esta tarea admite NuGet.org y fuentes autenticadas como Azure Artifacts y MyGet. Esta tarea también usa NuGet.exe y funciona con aplicaciones de .NET Framework. Para las aplicaciones de .NET Core y .NET Standard, use la tarea de .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. Obligatorio. Valores permitidos: restore, pack, push, custom. Valor predeterminado: restore.

Especifica el comando NuGet que se va a ejecutar. Use el custom valor para agregar argumentos o para usar un comando diferente.

restoreSolution - Ruta de acceso a la solución, packages.config o project.json
Alias de entrada: solution. string. Necesario cuando command = restore. Valor predeterminado: **/*.sln.

Especifica la ruta de acceso al archivo de solución, packages.config, o project.json que hace referencia a los paquetes que se van a restaurar.

feedsToUse - Fuentes que se van a usar
Alias de entrada: selectOrConfig. string. Necesario cuando command = restore. Valores permitidos: select (fuentes) que selecciono aquí), config (fuentes en mi NuGet.config). Valor predeterminado: select.

Especifica una fuente de Azure Artifacts o NuGet.org para que la tarea la use con el select valor . Como alternativa, puede confirmar un NuGet.config archivo en el repositorio de código fuente y establecer su ruta de acceso como valor mediante el config valor .

vstsFeed - Uso de paquetes de esta fuente de Azure Artifacts/TFS
Alias de entrada: feedRestore. string. Opcional. Use cuando selectOrConfig = select && command = restore.

Especifica la fuente seleccionada en el elemento generado NuGet.config. Debe tener la administración de paquetes instalada y con licencia para especificar una fuente aquí.

includeNuGetOrg - Uso de paquetes de NuGet.org
boolean. Opcional. Use cuando selectOrConfig = select && command = restore. Valor predeterminado: true.

Incluye NuGet.org en el elemento generado NuGet.config.

nugetConfigPath - Ruta de acceso a NuGet.config
string. Opcional. Use cuando selectOrConfig = config && command = restore.

Especifica la ruta de acceso a en el NuGet.config repositorio que determina las fuentes de las que se van a restaurar los paquetes.

externalFeedCredentials - Credenciales para fuentes fuera de esta organización o colección
Alias de entrada: externalEndpoints. string. Opcional. Use cuando selectOrConfig = config && command = restore.

Especifica las credenciales que se usarán para los registros externos ubicados en el seleccionado NuGet.config. Este es el nombre de la conexión del servicio NuGet. En el caso de las fuentes de esta organización o colección, deje este en blanco; Las credenciales de la compilación se usan automáticamente.

noCache - Deshabilitación de la caché local
boolean. Opcional. Use cuando command = restore. Valor predeterminado: false.

Impide que NuGet use paquetes de caché de máquinas locales cuando se establece en true.

disableParallelProcessing - Deshabilitación del procesamiento paralelo
boolean. Opcional. Use cuando command = restore. Valor predeterminado: false.

Impide que NuGet instale varios paquetes en procesos paralelos cuando se establece trueen .

restoreDirectory - Directorio de destino
Alias de entrada: packagesDirectory. string. Opcional. Use cuando command = restore.

Especifica la carpeta en la que se instalan los paquetes. Si no se especifica ninguna carpeta, los paquetes se restauran en una packages/ carpeta junto con la solución seleccionada, packages.configo project.json.

verbosityRestore - Detalle
string. Opcional. Use cuando command = restore. Valores permitidos: Quiet, Normal y Detailed. Valor predeterminado: Detailed.

Especifica la cantidad de detalles que se muestran en la salida.

packagesToPush - Ruta de acceso a los paquetes NuGet que se van a publicar
Alias de entrada: searchPatternPush. string. Necesario cuando command = push. Valor predeterminado: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.

Especifica el patrón que debe coincidir o ruta de acceso a los nupkg archivos que se van a cargar. Varios patrones se pueden separar mediante un punto y coma.

nuGetFeedType - Ubicación de fuente de destino
string. Necesario cuando command = push. Valores permitidos: internal (esta organización o colección), external (servidor NuGet externo (incluidas otras cuentas o colecciones)). Valor predeterminado: internal.

Especifica si la fuente de destino es una fuente o colección interna o un servidor NuGet externo.

publishVstsFeed - Fuente de destino
Alias de entrada: feedPublish. string. Necesario cuando command = push && nuGetFeedType = internal.

Especifica una fuente hospedada en esta cuenta. Debe tener instalado y con licencia Azure Artifacts para seleccionar una fuente aquí.

publishPackageMetadata - Publicar metadatos de canalización
boolean. Opcional. Use cuando command = push && nuGetFeedType = internal && command = push. Valor predeterminado: true.

Cambia el número de versión del subconjunto de paquetes modificados dentro de un conjunto de paquetes publicados continuamente.

allowPackageConflicts - Permitir que se omitan los duplicados
boolean. Opcional. Use cuando command = push && nuGetFeedType = internal. Valor predeterminado: false.

Notifica que la tarea se ha realizado correctamente aunque algunos de los paquetes se rechacen con errores de conflicto 409.

Esta opción solo está disponible actualmente en los agentes de Azure Pipelines y Windows. Si NuGet.exe encuentra un conflicto, se producirá un error en la tarea. Esta opción no funcionará y se producirá un error en la publicación si se encuentra dentro de un entorno de proxy.

publishFeedCredentials - Servidor NuGet
Alias de entrada: externalEndpoint. string. Necesario cuando command = push && nuGetFeedType = external.

Especifica la conexión del servicio NuGet que contiene las credenciales del servidor NuGet externo.

verbosityPush - Detalle
string. Opcional. Use cuando command = push. Valores permitidos: Quiet, Normal y Detailed. Valor predeterminado: Detailed.

Especifica la cantidad de detalles que se muestran en la salida.

packagesToPack - Ruta de acceso a csproj o archivos nuspec que se van a empaquetar
Alias de entrada: searchPatternPack. string. Necesario cuando command = pack. Valor predeterminado: **/*.csproj.

Especifica el patrón que usa la tarea para buscar directorios csproj que se van a empaquetar.

Puede separar varios patrones con un punto y coma y puede hacer que un patrón sea negativo con el prefijo !. Ejemplo: **\*.csproj;!**\*.Tests.csproj.

configuration - Configuración para empaquetar
Alias de entrada: configurationToPack. string. Opcional. Use cuando command = pack. Valor predeterminado: $(BuildConfiguration).

Especifica la configuración que se va a empaquetar cuando se usa un archivo csproj.

packDestination - Carpeta del paquete
Alias de entrada: outputDir. string. Opcional. Use cuando command = pack. Valor predeterminado: $(Build.ArtifactStagingDirectory).

Especifica la carpeta donde la tarea crea paquetes. Si el valor está vacío, la tarea crea paquetes en la raíz de origen.

versioningScheme - Control automático de versiones de paquetes
string. Necesario cuando command = pack. Valores permitidos: off, byPrereleaseNumber (Use la fecha y hora), byEnvVar (Use una variable de entorno) byBuildNumber (Use el número de compilación). Valor predeterminado: off.

Aplica el control de versiones automático del paquete en función del valor especificado. Esta cadena no se puede usar con includeReferencedProjects. Los valores permitidos son:

• byPrereleaseNumber - Use la fecha y hora: la tarea generará una versión compatible con SemVer con formato X.Y.Z-ci-datetime, donde se especifican los valores de X, Y y Z.
• byEnvVar- Usar una variable de entorno: la tarea usará una variable de entorno que especifique y contiene el número de versión que desea usar.
• byBuildNumber - Use el número de compilación: la tarea usará el número de compilación para versionar el paquete.

Nota

En General, establezca el formato de compilación en $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

includeReferencedProjects - Incluir proyectos a los que se hace referencia
boolean. Opcional. Use cuando versioningScheme = off && command = pack. Valor predeterminado: false.

Incluye proyectos a los que se hace referencia como dependencias o como parte del paquete. No se puede usar con versiones automáticas de paquetes. Si un proyecto al que se hace referencia tiene un archivo correspondiente nuspec que tiene el mismo nombre que el proyecto, ese proyecto al que se hace referencia se agrega como una dependencia. De lo contrario, el proyecto al que se hace referencia se agrega como parte del paquete. Obtenga más información sobre el uso del comando pack para la CLI de NuGet para crear paquetes NuGet.

versionEnvVar - Variable de entorno
string. Necesario cuando versioningScheme = byEnvVar && command = pack.

Especifica el nombre de la variable sin $, $envo %.

majorVersion - Destacado
Alias de entrada: requestedMajorVersion. string. Necesario cuando versioningScheme = byPrereleaseNumber && command = pack. Valor predeterminado: 1.

en la X versión X.Y.Z.

minorVersion - Menor
Alias de entrada: requestedMinorVersion. string. Necesario cuando versioningScheme = byPrereleaseNumber && command = pack. Valor predeterminado: 0.

en la Y versión X.Y.Z.

patchVersion - Parche
Alias de entrada: requestedPatchVersion. string. Necesario cuando versioningScheme = byPrereleaseNumber && command = pack. Valor predeterminado: 0.

en la Z versión X.Y.Z.

packTimezone - Zona horaria
string. Opcional. Use cuando versioningScheme = byPrereleaseNumber && command = pack. Valores permitidos: utc, local (hora local del agente). Valor predeterminado: utc.

Especifica la zona horaria deseada que se usa para generar la versión del paquete. utc Se recomienda seleccionar si usa agentes de compilación hospedados, ya que su fecha y hora pueden diferir.

includeSymbols - Crear paquete de símbolos
boolean. Opcional. Use cuando command = pack. Valor predeterminado: false.

Especifica que el paquete contiene orígenes y símbolos. Cuando se usa con un .nuspec archivo, esto crea un archivo de paquete NuGet normal y el paquete de símbolos correspondiente.

toolPackage - Paquete de herramientas
boolean. Opcional. Use cuando command = pack. Valor predeterminado: false.

Determina si los archivos de salida del proyecto deben estar en la carpeta de herramientas.

buildProperties - Propiedades de compilación adicionales
string. Opcional. Use cuando command = pack.

Especifica una lista de pares token=value, separados por punto y coma, donde cada aparición del $token$.nuspec archivo se reemplazará por el valor especificado. Los valores pueden ser cadenas entre comillas.

basePath - Ruta de acceso base
string. Opcional. Use cuando command = pack.

Especifica la ruta de acceso base de los archivos definidos en el nuspec archivo.

verbosityPack - Detalle
string. Opcional. Use cuando command = pack. Valores permitidos: Quiet, Normal y Detailed. Valor predeterminado: Detailed.

Especifica la cantidad de detalles que se muestran en la salida.

arguments - Comandos y argumentos
string. Necesario cuando command = custom.

Especifica el comando y los argumentos a NuGet.exe los que se pasará para su ejecución. Si se usa NuGet 3.5 o posterior, los comandos autenticados como list, restorey en publish cualquier fuente de esta organización o colección a la que tenga acceso el servicio de compilación de recopilación de proyectos se autenticarán automáticamente.

Opciones de control de tareas

Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Comentarios

Importante

La tarea Autenticación de NuGet es la nueva manera recomendada de autenticarse con Azure Artifacts y otros repositorios NuGet. Esta tarea ya no toma nuevas características y solo se solucionan errores críticos.

Use esta tarea para instalar y actualizar las dependencias de paquetes NuGet, o bien empaquetar y publicar paquetes NuGet. Usa NuGet.exe y funciona con aplicaciones de .NET Framework. Para las aplicaciones de .NET Core y .NET Standard, use la tarea de .NET Core.

Si el código depende de los paquetes NuGet, asegúrese de agregar este paso antes de la tarea de compilación de Visual Studio. Asegúrese también de desactivar la casilla Restaurar paquetes NuGet en desuso en esa tarea.

Si está trabajando con .NET Core o .NET Standard, use la tarea .NET Core , que tiene compatibilidad completa con todos los escenarios de paquetes y actualmente es compatible con dotnet.

Sugerencia

Esta versión de la tarea NuGet usa NuGet 4.1.0 de forma predeterminada. Para seleccionar una versión diferente de NuGet, use el Instalador de herramientas.

Esquemas de control de versiones

Para byPrereleaseNumber, la versión se establecerá en los valores que elija para la versión principal, la versión secundaria y la revisión, además de la fecha y hora, en el formato yyyymmdd-hhmmss.

Para byEnvVar, la versión se establecerá en el valor de la variable de entorno que tiene el nombre especificado por el parámetro versionEnvVar, por ejemplo MyVersion (no $, solo el nombre de la variable de entorno). Asegúrese de que la variable de entorno está establecida en un SemVer adecuado, como 1.2.3 o 1.2.3-beta1.

Para byBuildNumber, la versión se establecerá mediante el número de compilación de la ejecución de canalización. Este es el valor especificado para la propiedad de la canalización name, que se guarda en la variable de entorno BUILD_BUILDNUMBER). Asegúrese de que el número de compilación que se usa contiene un SemVer adecuado, como 1.0.$(Rev:r). Al usar byBuildNumber, la tarea extraerá la versión de puntos, 1.2.3.4, de la cadena de número de compilación y usará solo esa parte. El resto de la cadena se quitará. Si quiere usar el número de compilación tal como está, puede usar byEnvVar como se describió anteriormente y establecer versionEnvVar en BUILD_BUILDNUMBER.

Migración desde NuGetInstaller@0 o NuGetRestore@1

NuGetInstaller@0 y NuGetRestore@1 están en desuso y debe reemplazarlos en la canalización por NuGetCommand@2.

Si estaba usando NuGetInstaller@0 con restoreMode: restore, configure las entradas siguientes al usar NuGetCommand@2.

NuGetCommand@2 entrada de tarea	Valor
command	restore
restoreSolution	Ruta de acceso al archivo .sln

Si estaba usando NuGetInstaller@0 con restoreMode: install, configure las entradas siguientes al usar NuGetCommand@2.

NuGetCommand@2 entrada de tarea	Valor
command	custom
arguments	Qué aspecto tendría el comando de instalación completa en la CLI de NuGet. Por ejemplo, si desea ejecutar el equivalente de nuget install ninject -OutputDirectory c:\proj en la canalización, el arguments parámetro sería install ninject -OutputDirectory c:\proj. Si estaba usando el NuGetInstaller@0nuGetRestoreArgs parámetro , ahora también va en arguments.

Si estaba usando NuGetRestore@1, configure las entradas siguientes al usar NuGetCommand@2.

NuGetCommand@2 entrada de tarea	Valor
command	restore
restoreSolution	Ruta de acceso al archivo .sln

De forma similar al uso NuGetRestore@1 o larestoreNuGetInstaller@0opción , NuGetCommand@2 tiene entradas para establecer la fuente, decidir entre select o config, especificar la ruta de acceso al NuGet.config archivo y usar paquetes de nuget.org.

Para obtener más información, consulte los ejemplos siguientes.

Ejemplos

Restauración

Restaure todas las soluciones con paquetes de una fuente seleccionada.

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

Paquete

Cree un paquete NuGet en la carpeta de destino.

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

Insertar

Nota

Los artefactos de canalización se descargan en el directorio Pipeline.Workspace y en el directorio System.ArtifactsDirectory de las canalizaciones de versión clásicas. El valor packagesToPush se puede establecer en $(Pipeline.Workspace)/**/*.nupkg o $(System.ArtifactsDirectory)/**/*.nupkg respectivamente.

• Inserte o publique un paquete en una fuente definida en NuGet.config.

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

• Inserción o publicación de un paquete en una fuente con ámbito de organización

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

• Inserción o publicación de un paquete en una fuente con ámbito de proyecto

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

• Inserción o publicación de un paquete en NuGet.org

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

Personalizado

Ejecute cualquier otro comando NuGet además de los predeterminados: pack, push y restore.

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

Requisitos

Requisito	Descripción
Tipos de canalización	YAML, compilación clásica, versión clásica
Se ejecuta en	Agente, DeploymentGroup
Peticiones	None
Capabilities	Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
Restricciones de comandos	Any
Variables que se pueden establecer	Any
Versión del agente	2.144.0 o superior
Categoría de la tarea:	Paquete