DotNetCoreCLI@2: tarea de .NET Core v2

Compile, pruebe, empaquete o publique una aplicación de dotnet o bien ejecute un comando dotnet personalizado.

Syntax

# .NET Core v2
# Build, test, package, or publish a dotnet application, or run a custom dotnet command.
- task: DotNetCoreCLI@2
  inputs:
    command: 'build' # 'build' | 'push' | 'pack' | 'publish' | 'restore' | 'run' | 'test' | 'custom'. Required. Command. Default: build.
    #publishWebProjects: true # boolean. Optional. Use when command = publish. Publish web projects. Default: true.
    #projects: # string. Optional. Use when command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false. Path to project(s) or solution(s). 
    #custom: # string. Required when command = custom. Custom command. 
    #arguments: # string. Optional. Use when command = build || command = publish || command = run || command = test || command = custom. Arguments. 
    #restoreArguments: # string. Optional. Use when command = restore. Arguments. 
    #publishTestResults: true # boolean. Optional. Use when command = test. Publish test results and code coverage. Default: true.
    #testRunTitle: # string. Optional. Use when command = test. Test run title. 
    #zipAfterPublish: true # boolean. Optional. Use when command = publish. Zip published projects. Default: true.
    #modifyOutputPath: true # boolean. Optional. Use when command = publish. Add project's folder name to publish path. Default: true.
    #packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg' # string. Alias: searchPatternPush. Required when command = push. Path to NuGet package(s) to publish. Default: $(Build.ArtifactStagingDirectory)/*.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. 
    #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).
    #packDirectory: '$(Build.ArtifactStagingDirectory)' # string. Alias: outputDir. Optional. Use when command = pack. Package Folder. Default: $(Build.ArtifactStagingDirectory).
    #nobuild: false # boolean. Optional. Use when command = pack. Do not build. Default: false.
    #includesymbols: false # boolean. Optional. Use when command = pack. Include Symbols. Default: false.
    #includesource: false # boolean. Optional. Use when command = pack. Include Source. Default: false.
  # 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 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.
    #restoreDirectory: # string. Alias: packagesDirectory. Optional. Use when command = restore. Destination directory. 
    #verbosityRestore: 'Detailed' # '-' | 'Quiet' | 'Minimal' | 'Normal' | 'Detailed' | 'Diagnostic'. 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.
  # Pack options
    #versioningScheme: 'off' # 'off' | 'byPrereleaseNumber' | 'byEnvVar' | 'byBuildNumber'. Required when command = pack. Automatic package versioning. Default: off.
    #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.
  # Advanced
    #buildProperties: # string. Optional. Use when command = pack. Additional build properties. 
    #verbosityPack: 'Detailed' # '-' | 'Quiet' | 'Minimal' | 'Normal' | 'Detailed' | 'Diagnostic'. Optional. Use when command = pack. Verbosity. Default: Detailed.
  # Advanced
    #workingDirectory: # string. Optional. Use when command != restore && command != push && command != pack && command != pack && command != push && command != restore. Working directory.

Entradas

command - Comando
string. Obligatorio. Valores permitidos: build, push (inserción de nuget), pack, publishrestore, run, test, , . custom Valor predeterminado: build.

Comando dotnet que se va a ejecutar. Especifique custom para agregar argumentos o use un comando que no aparece aquí.

Importante

La tarea Autenticación de NuGet es la nueva manera recomendada de autenticarse con Azure Artifacts y otros repositorios NuGet. Los restore comandos y push de esta tarea de la CLI de .NET Core ya no toman nuevas características y solo se solucionan errores críticos. Consulte los comentarios para obtener más información.

publishWebProjects - Publicación de proyectos web
boolean. Opcional. Use cuando command = publish. Valor predeterminado: true.

Si esta entrada se establece trueen , se omite el valor de la projects propiedad y la tarea intenta buscar los proyectos web en el repositorio y ejecutar el comando publish en ellos. Los proyectos web se identifican por la presencia de un web.config archivo o una wwwroot carpeta en el directorio. En ausencia de un web.config archivo o una wwwroot carpeta, se seleccionan los proyectos que usan un SDK web, como Microsoft.NET.Sdk.Web, .

projects - Ruta de acceso a proyectos o soluciones
string. Opcional. Use cuando command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false.

Ruta de acceso a los .csproj archivos o .sln que se van a usar. Puede usar caracteres comodín (por ejemplo, **/*.csproj para todos los .csproj archivos de todas las subcarpetas). Para obtener más información, consulte la referencia de patrones de coincidencia de archivos.

Esta ruta de acceso es relativa a la raíz del repositorio, independientemente de la workingDirectory configuración.

custom - Comando personalizado
string. Necesario cuando command = custom.

Comando al que se va a dotnet.exe pasar para su ejecución. Para obtener una lista completa de los comandos disponibles, consulte la documentación de la CLI de dotnet.

arguments - Argumentos
string. Opcional. Use cuando command = build || command = publish || command = run || command = test || command = custom.

Especifica los argumentos del comando seleccionado. Por ejemplo, la configuración de compilación, la carpeta de salida y el entorno de ejecución. Los argumentos dependen del comando seleccionado.

Actualmente, esta entrada solo acepta argumentos para build, publish, run, testy custom. Si desea agregar argumentos para un comando que no aparece en la lista, use custom.

restoreArguments - Argumentos
string. Opcional. Use cuando command = restore.

Escribe los argumentos adicionales que se van a pasar al restore comando .

publishTestResults - Publicación de resultados de pruebas y cobertura de código
boolean. Opcional. Use cuando command = test. Valor predeterminado: true.

Al habilitar esta opción, se generará un test results archivo TRX en y los resultados se publicarán en $(Agent.TempDirectory)el servidor.

Esta opción anexa --logger trx --results-directory $(Agent.TempDirectory) a los argumentos de la línea de comandos.

La cobertura de código se puede recopilar agregando la --collect "Code coverage" opción a los argumentos de la línea de comandos.

testRunTitle - Título de la ejecución de pruebas
string. Opcional. Use cuando command = test.

Proporciona un nombre para la ejecución de pruebas.

zipAfterPublish - Proyectos publicados en zip
boolean. Opcional. Use cuando command = publish. Valor predeterminado: true.

Si esta entrada se establece trueen , las carpetas creadas por el comando publish se comprimirán y eliminarán.

modifyOutputPath - Agregar el nombre de la carpeta del proyecto para publicar la ruta de acceso
boolean. Opcional. Use cuando command = publish. Valor predeterminado: true.

Si esta entrada se establece trueen , las carpetas creadas por el comando publish tendrán el nombre de archivo del proyecto precedido a sus nombres de carpeta cuando la ruta de acceso de salida se especifique explícitamente en argumentos. Esto resulta útil si quiere publicar varios proyectos en la misma carpeta.

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.

Puede seleccionar una fuente de Azure Artifacts o NuGet.org aquí, o bien puede confirmar un nuget.config archivo en el repositorio de código fuente y establecer su ruta de acceso mediante la nugetConfigPath entrada.

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

Incluye la fuente seleccionada en el elemento generado NuGet.config. Debe tener la administración de paquetes instalada y con licencia para seleccionar una fuente aquí. projectName/feedName se usan para fuentes con ámbito de proyecto. Solo FeedName se usa para fuentes con ámbito de organización. Nota: Esto no se admite para el comando de prueba.

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

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

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

en NuGet.config el repositorio que especifica 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.

Las credenciales que se usarán para los registros externos ubicados en el seleccionado NuGet.config. Para las fuentes de esta organización o colección, deje esta entrada 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 utilice paquetes de la memoria caché de las máquinas locales.

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 la caché de paquetes NuGet predeterminada.

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

Especifica la cantidad de detalles que se muestran en la salida para el comando restore.

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.

Patrón que debe coincidir o ruta de acceso a los nupkg archivos que se van a cargar. Se pueden separar varios patrones con un punto y coma y puede hacer que un patrón sea negativo con el prefijo !. Ejemplo: **/*.nupkg;!**/*.Tests.nupkg.

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 organizaciones o colecciones)). Valor predeterminado: internal.

Especifica si la fuente de destino es interna o externa.

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

Especifica una fuente hospedada en esta organización. Debe tener la administración de paquetes instalada y con licencia para seleccionar una fuente aquí.

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

Asocia los metadatos de esta canalización de compilación o versión (ejecutar #, información de código fuente) con el paquete.

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

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

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.

Patrón que se va a buscar .csproj o .nuspec a los archivos 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 al paquete
Alias de entrada: configurationToPack. string. Opcional. Use cuando command = pack. Valor predeterminado: $(BuildConfiguration).

Cuando se usa un .csproj archivo, esta entrada especifica la configuración que se va a empaquetar.

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

Carpeta donde se crearán los paquetes. Si esta carpeta está vacía, los paquetes se crearán junto con el csproj archivo.

nobuild - No compilar
boolean. Opcional. Use cuando command = pack. Valor predeterminado: false.

Especifica que la tarea no compilará el proyecto antes de empaquetar. Esta tarea corresponde al --no-build parámetro del build comando .

includesymbols - Incluir símbolos
boolean. Opcional. Use cuando command = pack. Valor predeterminado: false.

Crea paquetes NuGet de símbolos. Esta tarea corresponde al parámetro de --include-symbols la línea de comandos.

includesource - Incluir origen
boolean. Opcional. Use cuando command = pack. Valor predeterminado: false.

Incluye el código fuente en el paquete. Esta tarea corresponde al parámetro de --include-source la línea de comandos.

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.

Esta tarea no se puede usar con proyectos a los que se hace referencia. Si elige Use the date and time, se generará una versión compatible con SemVer con formato donde X.Y.Z-ci-datetime elija X, Yy Z.

Si elige Use an environment variable, debe seleccionar una variable de entorno y asegurarse de que contiene el número de versión que desea usar.

Si elige Use the build number, usará el número de compilación para la versión del paquete. Nota: En Options, establezca el formato del número de compilación en $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

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.

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

Especifica una lista de token = value pares, 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.

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

Especifica la cantidad de detalles que se muestran en la salida para el comando pack.

workingDirectory - Directorio de trabajo
string. Opcional. Use cuando command != restore && command != push && command != pack && command != pack && command != push && command != restore.

Directorio de trabajo actual donde se ejecuta el script. Empty es la raíz del repositorio (compilación) o artefactos (versión), que es $(System.DefaultWorkingDirectory).

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. Los restore comandos y push de esta tarea de la CLI de .NET Core ya no toman nuevas características y solo se solucionan errores críticos.

¿Por qué mi paso de compilación, publicación o prueba genera un error al restaurar paquetes?

La mayoría de los comandos dotnet, entre ellos build, publish y test, incluyen un paso restore implícito. Esto producirá un error en las fuentes autenticadas, incluso si ejecutó un comando dotnet restorecorrecto en un paso anterior, ya que este habrá limpiado las credenciales que usó.

Para corregir este problema, agregue la --no-restore marca al cuadro de Arguments texto.

Además, el test comando no reconoce los feedRestore argumentos o vstsFeed y las fuentes especificadas de esta manera no se incluirán en el archivo generado NuGet.config cuando se ejecute el paso implícito restore . Se recomienda usar un paso explícito dotnet restore para restaurar paquetes. El comando restore respeta los argumentos feedRestore y vstsFeed.

¿Por qué recibo advertencias NU1507 con asignación de origen de paquetes aunque al compilar en mi máquina no tiene advertencias?

Los distintos comandos que realizan una restauración de NuGet o acceden a una fuente de NuGet crean un archivo temporal NuGet.config especial que agrega autenticación de NuGet para fuentes NuGet de artefactos de Azure. La forma en que esto se hace está en conflicto con el esquema que usa la asignación de origen del paquete para asignar los paquetes a los orígenes y interrumpe la configuración de Mappin de origen del paquete en el NuGet.config archivo del repositorio. Para solucionar este conflicto, puede usar la tarea Autenticación de NuGet para autenticar y, después, el comando personalizado para invocar el comando dotnet deseado sin la NuGet.config modificación.

# Authenticate Azure DevOps NuGet feed
- task: NuGetAuthenticate@1
  displayName: 'Authenticate Azure DevOps NuGet feed'

# Restore project
- task: DotNetCoreCLI@2
  inputs:
    command: 'custom'
    custom: 'restore'

# Build project
- task: DotNetCoreCLI@2
  inputs:
    command: 'custom'
    custom: 'build'
    arguments: '--no-restore'

¿Por qué debo proteger una instancia de NuGet.config?

La comprobación de un NuGet.config control de código fuente garantiza que un fragmento de información clave necesario para compilar el proyecto (la ubicación de sus paquetes) está disponible para todos los desarrolladores que desprotecionen el código.

Sin embargo, en situaciones en las que un equipo de desarrolladores trabaja en una gran variedad de proyectos, también es posible agregar una fuente de Azure Artifacts al entorno global NuGet.config en la máquina de cada desarrollador. En estas situaciones, el uso de la Feeds I select here opción en la tarea NuGet replica esta configuración.

Solución de problemas

El proyecto que usa Entity Framework ha dejado de funcionar en Agentes hospedados

.NET Core no tiene integrado Entity Framework(EF). Tendrá que instalar EF antes de comenzar la ejecución o agregar global.json al proyecto con la versión necesaria del SDK de .NET Core. Esto garantizará que se use el SDK correcto para compilar el proyecto de EF. Si la versión necesaria no está presente en el equipo, agregue la UseDotNetV2 tarea a la canalización para instalar la versión necesaria. Para más información, consulte Obtención del entorno de ejecución de Entity Framework Core.

Ejemplos

• Ejemplos de compilación
• Ejemplos de inserción
• Ejemplos de inserción
• Ejemplos de paquetes
• Publicación de ejemplos
• Ejemplos de restauración
• Ejemplos de pruebas

Ejemplos de compilación

Compilar un proyecto

# Build project
- task: DotNetCoreCLI@2
  inputs:
    command: 'build'

Compilar varios proyectos

# Build multiple projects
- task: DotNetCoreCLI@2
  inputs:
    command: 'build'
    projects: |
      src/proj1/proj1.csproj 
      src/proj2/proj2.csproj 
      src/other/other.sln    # Pass a solution instead of a csproj.

Ejemplos de inserción

Insertar paquetes NuGet en fuente interna

# Push non test NuGet packages from a build to internal organization Feed
- task: DotNetCoreCLI@2
  inputs:
    command: 'push'
    searchPatternPush: '$(Build.ArtifactStagingDirectory)/*.nupkg;!$(Build.ArtifactStagingDirectory)/*.Tests.nupkg'
    feedPublish: 'FabrikamFeed'

Insertar paquetes NuGet en fuente externa

# Push all NuGet packages from a build to external Feed
- task: DotNetCoreCLI@2
  inputs:
    command: 'push'
    nugetFeedType: 'external'
    externalEndPoint: 'MyNuGetServiceConnection'

Ejemplos de paquetes

Empaquetar un NuGetPackage en un directorio de salida específico

# Pack a NuGet package to a test directory
- task: DotNetCoreCLI@2
  inputs: 
    command: 'pack'
    outputDir: '$(Build.ArtifactStagingDirectory)/TestDir'

Empaquetar un paquete de símbolos

# Pack a symbol package along with NuGet package
- task: DotNetCoreCLI@2
  inputs: 
    command: 'pack'
    includesymbols: true

Publicación de ejemplos

Publicar proyectos en la carpeta especificada

# Publish projects to specified folder.
- task: DotNetCoreCLI@2
  displayName: 'dotnet publish'
  inputs:
    command: 'publish'
    publishWebProjects: false
    projects: '**/*.csproj'
    arguments: '-o $(Build.ArtifactStagingDirectory)/Output'
    zipAfterPublish: true
    modifyOutputPath: true

Ejemplos de restauración

#Restore packages with the .NET Core CLI task
- task: DotNetCoreCLI@2
  displayName: 'dotnet restore'
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    feedRestore: 'projectName/feedName'
    projects: '**/*.csproj'
    includeNuGetOrg: true

Ejemplos de pruebas

Ejecutar pruebas en el repositorio

# Run tests and auto publish test results.
- task: DotNetCoreCLI@2
  inputs:
    command: 'test'

Requisitos

Requisito	Descripción
Tipos de canalización	YAML, compilación clásica, versión clásica
Se ejecuta en	Agente
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:	Build