DotNetCoreCLI@2 - Attività .NET Core v2

Compilare, testare, creare un pacchetto o pubblicare un'applicazione dotnet oppure eseguire un comando dotnet personalizzato.

Sintassi

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

Input

command - Comando
string. Obbligatorio. Valori consentiti: build, push (push nuget), pack, , publishrestore, run, test, custom. Valore predefinito: build.

Comando dotnet da eseguire. Specificare custom per aggiungere argomenti o usare un comando non elencato qui.

Importante

L'attività Autenticazione NuGet è il nuovo modo consigliato per eseguire l'autenticazione con Azure Artifacts e altri repository NuGet. I restore comandi e push di questa attività dell'interfaccia della riga di comando di .NET Core non accettano più nuove funzionalità e vengono risolti solo i bug critici. Per informazioni dettagliate, vedere le osservazioni.

publishWebProjects - Pubblicare progetti Web
boolean. facoltativo. Usare quando command = publish. Valore predefinito: true.

Se questo input è impostato su true, il valore della projects proprietà viene ignorato e l'attività tenta di trovare i progetti Web nel repository ed eseguire il comando publish su di essi. I progetti Web sono identificati dalla presenza di un web.config file o di una wwwroot cartella nella directory. In assenza di un file o di una web.configwwwroot cartella, vengono selezionati i progetti che usano un SDK Web, ad esempio Microsoft.NET.Sdk.Web, .

projects - Percorso di progetti o soluzioni
string. facoltativo. Usare quando command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false.

Percorso dei .csproj file o .sln da usare. È possibile usare caratteri jolly, ad esempio **/*.csproj per tutti i .csproj file in tutte le sottocartelle. Per altre informazioni, vedere le informazioni di riferimento sui modelli di corrispondenza dei file.

Questo percorso è relativo alla radice del repository indipendentemente dall'impostazione workingDirectory .

custom - Comando personalizzato
string. Obbligatorio quando command = custom.

Comando da passare a dotnet.exe per l'esecuzione. Per un elenco completo dei comandi disponibili, vedere la documentazione dell'interfaccia della riga di comando dotnet.

arguments - Argomenti
string. facoltativo. Usare quando command = build || command = publish || command = run || command = test || command = custom.

Specifica gli argomenti per il comando selezionato. Ad esempio, la configurazione della compilazione, la cartella di output e il runtime. Gli argomenti dipendono dal comando selezionato.

Questo input attualmente accetta solo argomenti per build, publish, run, teste custom. Se si desidera aggiungere argomenti per un comando non elencato, usare custom.

restoreArguments - Argomenti
string. facoltativo. Usare quando command = restore.

Scrive gli argomenti aggiuntivi da passare al restore comando.

publishTestResults - Pubblicare i risultati e il code coverage dei test
boolean. facoltativo. Usare quando command = test. Valore predefinito: true.

L'abilitazione di questa opzione genererà un test results file TRX in $(Agent.TempDirectory)e i risultati verranno pubblicati nel server.

Questa opzione aggiunge --logger trx --results-directory $(Agent.TempDirectory) agli argomenti della riga di comando.

Il code coverage può essere raccolto aggiungendo l'opzione --collect "Code coverage" agli argomenti della riga di comando.

testRunTitle - Titolo esecuzione test
string. facoltativo. Usare quando command = test.

Fornisce un nome per l'esecuzione del test.

zipAfterPublish - Comprimere i progetti pubblicati
boolean. facoltativo. Usare quando command = publish. Valore predefinito: true.

Se questo input è impostato su true, le cartelle create dal comando publish verranno compresse ed eliminate.

modifyOutputPath - Aggiungere il nome della cartella del progetto per pubblicare il percorso
boolean. facoltativo. Usare quando command = publish. Valore predefinito: true.

Se questo input è impostato su true, le cartelle create dal comando publish avranno il nome del file di progetto preceduto dai nomi di cartella quando il percorso di output viene specificato in modo esplicito negli argomenti. Ciò è utile se si desidera pubblicare più progetti nella stessa cartella.

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

È possibile selezionare un feed da Azure Artifacts e/o NuGet.org qui oppure eseguire il commit di un nuget.config file nel repository del codice sorgente e impostarne il percorso usando l'input nugetConfigPath .

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

Include il feed selezionato nell'oggetto generato NuGet.config. È necessario che Gestione pacchetti sia installato e concesso in licenza per selezionare un feed qui. projectName/feedName vengono usati per i feed con ambito progetto. Viene usato solo FeedName per i feed con ambito dell'organizzazione. Nota: non è supportato per il comando di test.

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

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

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

Nel NuGet.config repository che specifica i feed da cui ripristinare i pacchetti.

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

Le credenziali da usare per i registri esterni che si trovano nell'oggetto selezionato NuGet.config. Per i feed in questa organizzazione/raccolta, lasciare vuoto questo input; le credenziali della compilazione vengono usate automaticamente.

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

Impedisce a NuGet di usare pacchetti da cache del computer locale.

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

Specifica la cartella in cui vengono installati i pacchetti. Se non viene specificata alcuna cartella, i pacchetti vengono ripristinati nella cache predefinita del pacchetto NuGet.

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

Specifica la quantità di dettagli visualizzati nell'output per il restore comando.

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

Modello da associare o percorso ai nupkg file da caricare. Più modelli possono essere separati da un punto e virgola e si può rendere negativo un modello prefissi con !. Esempio: **/*.nupkg;!**/*.Tests.nupkg.

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

Specifica se il feed di destinazione è interno o esterno.

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

Specifica un feed ospitato in questa organizzazione. È necessario che Gestione pacchetti sia installato e concesso in licenza per selezionare un feed qui.

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

Associa i metadati della pipeline di compilazione/rilascio (eseguire #, informazioni sul codice sorgente) al pacchetto.

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

Connessione al servizio NuGet che contiene le credenziali del server NuGet esterno.

packagesToPack - Percorso di csproj o file nuspec per il pacchetto
Alias di input: searchPatternPack. string. Obbligatorio quando command = pack. Valore predefinito: **/*.csproj.

Modello da cercare .csproj o .nuspec file da assegnare al pacchetto.

È possibile separare più modelli con un punto e virgola e è possibile rendere negativo un modello prefissi con !. Esempio: **/*.csproj;!**/*.Tests.csproj.

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

Quando si usa un .csproj file, questo input specifica la configurazione per il pacchetto.

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

Cartella in cui verranno creati i pacchetti. Se questa cartella è vuota, i pacchetti verranno creati insieme al csproj file.

nobuild - Non compilare
boolean. facoltativo. Usare quando command = pack. Valore predefinito: false.

Specifica che l'attività non compilerà il progetto prima della compressione. Questa attività corrisponde al --no-build parametro del build comando .

includesymbols - Includi simboli
boolean. facoltativo. Usare quando command = pack. Valore predefinito: false.

Crea pacchetti NuGet di simboli. Questa attività corrisponde al parametro della --include-symbols riga di comando.

includesource - Includi origine
boolean. facoltativo. Usare quando command = pack. Valore predefinito: false.

Include il codice sorgente nel pacchetto. Questa attività corrisponde al parametro della --include-source riga di comando.

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

Questa attività non può essere utilizzata con i progetti a cui si fa riferimento inclusi. Se si sceglie Use the date and time, verrà generata una versione conforme a SemVer formattata come in X.Y.Z-ci-datetime cui si sceglie X, Ye Z.

Se si sceglie Use an environment variable, è necessario selezionare una variabile di ambiente e assicurarsi che contenga il numero di versione da usare.

Se si sceglie Use the build number, verrà usato il numero di build per la versione del pacchetto. Nota: In Optionsimpostare il formato del numero di build su $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

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

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

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

Nella X versione X.Y.Z.

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

Nella Y versione X.Y.Z.

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

Nella Z versione X.Y.Z.

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

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

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

Specifica la quantità di dettaglio visualizzata nell'output per il pack comando.

workingDirectory - Directory di lavoro
string. facoltativo. Usare quando command != restore && command != push && command != pack && command != pack && command != push && command != restore.

Directory di lavoro corrente in cui viene eseguito lo script. Empty è la radice del repository (build) o degli artefatti (versione), ovvero $(System.DefaultWorkingDirectory).

Opzioni di controllo delle attività

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

Variabili di output

Nessuno.

Osservazioni

Importante

L'attività Autenticazione NuGet è il nuovo modo consigliato per eseguire l'autenticazione con Azure Artifacts e altri repository NuGet. I restore comandi e push di questa attività dell'interfaccia della riga di comando di .NET Core non accettano più nuove funzionalità e vengono risolti solo i bug critici.

Perché la compilazione, la pubblicazione o il passaggio di test non riesce a ripristinare i pacchetti?

La maggior parte dei dotnet comandi, tra cui build, publishe test include un passaggio implicito restore . Questo errore avrà esito negativo nei feed autenticati, anche se è stato eseguito correttamente dotnet restore in un passaggio precedente, perché il passaggio precedente avrà pulito le credenziali usate.

Per risolvere questo problema, aggiungere il --no-restore flag alla Arguments casella di testo.

Inoltre, il test comando non riconosce gli feedRestore argomenti o vstsFeed e i feed specificati in questo modo non verranno inclusi nel file generato NuGet.config quando viene eseguito il passaggio implicito restore . È consigliabile usare un passaggio esplicito dotnet restore per ripristinare i pacchetti. Il restore comando rispetta gli feedRestore argomenti e vstsFeed .

Perché vengono visualizzati avvisi NU1507 con mapping dell'origine del pacchetto , anche se durante la compilazione nel computer non sono presenti avvisi?

I vari comandi che eseguono un ripristino NuGet o accedono a un feed NuGet creano un file temporaneo NuGet.config speciale che aggiunge l'autenticazione NuGet per i feed NuGet degli artefatti di Azure. Il modo in cui viene eseguita questa operazione è in conflitto con lo schema usato dal mapping dell'origine pacchetto per eseguire il mapping dei pacchetti alle origini e interrompe la configurazione della puntina origine pacchetto nel NuGet.config file nel repository. Per risolvere questo conflitto, è possibile usare l'attività Autenticazione NuGet per autenticare e successivamente il comando personalizzato per richiamare il comando dotnet desiderato senza la NuGet.config modifica.

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

Perché è consigliabile archiviare un NuGet.config?

L'archiviazione di un NuGet.config controllo del codice sorgente garantisce che una parte chiave di informazioni necessarie per compilare il progetto, ovvero la posizione dei pacchetti, sia disponibile per ogni sviluppatore che controlla il codice.

Tuttavia, per situazioni in cui un team di sviluppatori lavora su un'ampia gamma di progetti, è anche possibile aggiungere un feed di Azure Artifacts al globale NuGet.config nel computer di ogni sviluppatore. In queste situazioni, l'uso dell'opzione Feeds I select here nell'attività NuGet replica questa configurazione.

Risoluzione dei problemi

Il progetto che usa Entity Framework ha smesso di lavorare sugli agenti ospitati

.NET Core non dispone di Entity Framework (EF) predefinito. È necessario installare EF prima di iniziare l'esecuzione o aggiungere global.json al progetto con la versione richiesta di .NET Core SDK. In questo modo si garantisce che venga usato l'SDK corretto per compilare il progetto EF. Se la versione richiesta non è presente nel computer, aggiungere l'attività UseDotNetV2 alla pipeline per installare la versione richiesta. Per altre informazioni, vedere Ottenere il runtime di Entity Framework Core.

Esempio

• Esempi di compilazione
• Esempi di push
• Esempi di push
• Esempi di pack
• Pubblicare esempi
• Esempi di ripristino
• Esempi di test

Esempi di compilazione

Creare un progetto

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

Compilare più progetti

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

Esempi di push

Eseguire il push di pacchetti NuGet nel feed interno

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

Eseguire il push dei pacchetti NuGet nel feed esterno

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

Esempi di pack

Creare un pacchetto NuGetPackage in una directory di output specifica

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

Creare un pacchetto di simboli

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

Pubblicare esempi

Pubblicare progetti nella cartella specificata

# 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

Esempi di ripristino

#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

Esempi di test

Eseguire test nel repository

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

Requisiti

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