DotNetCoreCLI@2 – .NET Core v2-uppgift

Skapa, testa, paketera eller publicera ett dotnet-program eller kör ett anpassat dotnet-kommando.

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.

Indata

command - Kommandot
string. Krävs. Tillåtna värden: build, push (nuget push), pack, publish, restore, run, test, custom. Standardvärde: build.

Dotnet-kommandot som ska köras. Ange custom om du vill lägga till argument eller använda ett kommando som inte visas här.

Viktigt

NuGet Authenticate-uppgiften är det nya rekommenderade sättet att autentisera med Azure Artifacts och andra NuGet-lagringsplatser. Kommandona restore och push för den här .NET Core CLI-uppgiften tar inte längre nya funktioner och endast kritiska buggar åtgärdas. Mer information finns i kommentarer.

publishWebProjects - Publicera webbprojekt
boolean. Valfritt. Använd när command = publish. Standardvärde: true.

Om indata är inställda trueprojects på hoppas egenskapsvärdet över och aktiviteten försöker hitta webbprojekten på lagringsplatsen och köra publiceringskommandot på dem. Webbprojekt identifieras genom förekomsten av antingen en web.config fil eller en wwwroot mapp i katalogen. I avsaknad av en web.config fil eller mapp wwwroot väljs projekt som använder en webb-SDK, t.ex Microsoft.NET.Sdk.Web. , .

projects - Sökväg till projekt eller lösningar
string. Valfritt. Använd när command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false.

Sökvägen till den eller .sln de filer som .csproj ska användas. Du kan använda jokertecken (t.ex. **/*.csproj för alla .csproj filer i alla undermappar). Mer information finns i referensen för filmatchningsmönster.

Den här sökvägen är relativ till lagringsplatsens rot oavsett workingDirectory inställning.

custom - Anpassat kommando
string. Krävs när command = custom.

Kommandot som ska skickas till dotnet.exe för körning. En fullständig lista över tillgängliga kommandon finns i dotnet CLI-dokumentationen.

arguments - Argument
string. Valfritt. Använd när command = build || command = publish || command = run || command = test || command = custom.

Anger argumenten för det valda kommandot. Till exempel byggkonfiguration, utdatamapp och körning. Argumenten beror på vilket kommando som valts.

Dessa indata accepterar för närvarande endast argument för build, publish, run, testoch custom. Om du vill lägga till argument för ett kommando som inte visas använder du custom.

restoreArguments - Argument
string. Valfritt. Använd när command = restore.

Skriver de ytterligare argument som ska skickas restore till kommandot.

publishTestResults - Publicera testresultat och kodtäckning
boolean. Valfritt. Använd när command = test. Standardvärde: true.

Om du aktiverar det här alternativet genereras en test results TRX-fil i $(Agent.TempDirectory)och resultatet publiceras till servern.

Det här alternativet lägger till --logger trx --results-directory $(Agent.TempDirectory) kommandoradsargumenten.

Kodtäckning kan samlas in genom att lägga till --collect "Code coverage" alternativet i kommandoradsargumenten.

testRunTitle - Testkörningsrubrik
string. Valfritt. Använd när command = test.

Anger ett namn för testkörningen.

zipAfterPublish - Zip-publicerade projekt
boolean. Valfritt. Använd när command = publish. Standardvärde: true.

Om den här indatan är inställd på truekommer mappar som skapats av publiceringskommandot att zippas och tas bort.

modifyOutputPath - Lägg till projektets mappnamn i publiceringssökvägen
boolean. Valfritt. Använd när command = publish. Standardvärde: true.

Om den här indatan är inställd på truekommer mappar som skapas av publiceringskommandot att ha projektfilnamnet prefixet till deras mappnamn när utdatasökvägen uttryckligen anges i argument. Det här är användbart om du vill publicera flera projekt i samma mapp.

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

Du kan antingen välja en feed från Azure Artifacts och/eller NuGet.org här, eller så kan du checka in en nuget.config fil till källkodslagringsplatsen och ange sökvägen med hjälp av nugetConfigPath indata.

vstsFeed - Använda paket från den här Azure Artifacts-feeden
Indataalias: feedRestore. string. Valfritt. Använd när selectOrConfig = select && command = restore.

Innehåller den valda feeden i den genererade NuGet.config. Du måste ha Package Management installerat och licensierat för att välja en feed här. projectName/feedName används för feeds med projektomfattning. Endast FeedName används för feeds med organisationsomfattning. Obs! Det här stöds inte för testkommandot.

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

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

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

På NuGet.config din lagringsplats som anger de feeds som paketen ska återställas från.

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

De autentiseringsuppgifter som ska användas för externa register som finns i den valda NuGet.config. För feeds i den här organisationen/samlingen lämnar du dessa indata tomma. byggets autentiseringsuppgifter används automatiskt.

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

Hindrar NuGet från att använda paket från lokala datorcacheminnen.

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

Anger mappen där paket installeras. Om ingen mapp anges återställs paketen till nuGet-standardpaketcacheminnet.

verbosityRestore - Informationsnivån
string. Valfritt. Använd när command = restore. Tillåtna värden: -, Quiet, Minimal, Normal, Detailed, Diagnostic. Standardvärde: Detailed.

Anger mängden information som visas i utdata för restore kommandot.

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

Mönstret för att matcha eller sökvägen till nupkg filer som ska laddas upp. Flera mönster kan avgränsas med ett semikolon och du kan göra ett mönster negativt genom att prefixera det med !. Exempel: **/*.nupkg;!**/*.Tests.nupkg.

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

Anger om målfeeden är intern eller extern.

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

Anger ett flöde som finns i den här organisationen. Du måste ha Package Management installerat och licensierat för att välja en feed här.

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

Associerar den här bygg-/versionspipelinens metadata (kör #, källkodsinformation) med paketet.

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

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

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

Mönstret för att söka .csproj efter eller .nuspec filer som ska packas.

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

configuration - Konfiguration till paket
Indataalias: configurationToPack. string. Valfritt. Använd när command = pack. Standardvärde: $(BuildConfiguration).

När du använder en .csproj fil anger indata konfigurationen som ska paketeras.

packDirectory - Paketmapp
Indataalias: outputDir. string. Valfritt. Använd när command = pack. Standardvärde: $(Build.ArtifactStagingDirectory).

Mappen där paket ska skapas. Om den här mappen är tom skapas paket tillsammans csproj med filen.

nobuild - Skapa inte
boolean. Valfritt. Använd när command = pack. Standardvärde: false.

Anger att aktiviteten inte kommer att skapa projektet innan du packar. Den här uppgiften motsvarar parametern --no-build för build kommandot.

includesymbols - Inkludera symboler
boolean. Valfritt. Använd när command = pack. Standardvärde: false.

Skapar symbolen NuGet-paket. Den här uppgiften motsvarar kommandoradsparametern --include-symbols .

includesource - Inkludera källa
boolean. Valfritt. Använd när command = pack. Standardvärde: false.

Innehåller källkod i paketet. Den här uppgiften motsvarar kommandoradsparametern --include-source .

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

Den här uppgiften kan inte användas med inkluderade refererade projekt. Om du väljer Use the date and timegenererar detta en SemVer-kompatibel version formaterad som X.Y.Z-ci-datetime där du väljer X, Yoch Z.

Om du väljer Use an environment variablemåste du välja en miljövariabel och se till att den innehåller det versionsnummer som du vill använda.

Om du väljer Use the build numberanvänder detta versionsnumret för att version ditt paket. Observera: Under Optionsanger du versionsnummerformatet till $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

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

Anger variabelnamnet utan $, $enveller %.

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

I-version XX.Y.Z.

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

I-version YX.Y.Z.

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

I-version ZX.Y.Z.

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

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

verbosityPack - Informationsnivån
string. Valfritt. Använd när command = pack. Tillåtna värden: -, Quiet, Minimal, Normal, Detailed, Diagnostic. Standardvärde: Detailed.

Anger mängden information som visas i utdata för pack kommandot.

workingDirectory - Arbetskatalog
string. Valfritt. Använd när command != restore && command != push && command != pack && command != pack && command != push && command != restore.

Den aktuella arbetskatalogen där skriptet körs. Empty är roten för lagringsplatsen (build) eller artefakter (release), som är $(System.DefaultWorkingDirectory).

Kontrollalternativ för aktivitet

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

Utdatavariabler

Inga.

Kommentarer

Viktigt

NuGet Authenticate-uppgiften är det nya rekommenderade sättet att autentisera med Azure Artifacts och andra NuGet-lagringsplatser. Kommandona restore och push för den här .NET Core CLI-uppgiften tar inte längre nya funktioner och endast kritiska buggar åtgärdas.

Varför misslyckas mitt bygg-, publicerings- eller teststeg med att återställa paket?

De flesta dotnet kommandon, inklusive build, publishoch test innehåller ett implicit restore steg. Detta misslyckas mot autentiserade flöden, även om du körde ett lyckat dotnet restore tidigare steg, eftersom det tidigare steget har rensat de autentiseringsuppgifter som användes.

Åtgärda problemet genom att lägga till --no-restore flaggan i Arguments textrutan.

Dessutom test känner kommandot inte igen argumenten feedRestore eller vstsFeed och feeds som anges på det här sättet tas inte med i den genererade NuGet.config filen när det implicita restore steget körs. Vi rekommenderar att du använder ett explicit dotnet restore steg för att återställa paket. Kommandot restore respekterar argumenten feedRestore och vstsFeed .

Varför får jag NU1507-varningar med paketkällmappning , men när jag bygger på min dator har det inga varningar?

De olika kommandona som gör en NuGet-återställning eller har åtkomst till en NuGet-feed skapar en särskild tillfällig NuGet.config fil som lägger till NuGet-autentisering för Azure Artifacts NuGet-feeds. Det sätt som detta görs är i konflikt med schemat som paketkällmappning använder för att mappa paketen till källorna och bryter paketkällmappningskonfigurationen NuGet.config i filen på lagringsplatsen. Om du vill kringgå den här konflikten kan du använda uppgiften NuGet Authenticate för att autentisera och därefter det anpassade kommandot för att anropa det önskade dotnet-kommandot utan att ändra.NuGet.config

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

Varför ska jag checka in en NuGet.config?

Genom att checka in en NuGet.config källkontroll ser du till att en viktig information som behövs för att skapa projektet – platsen för dess paket – är tillgänglig för alla utvecklare som checkar ut koden.

Men för situationer där ett team med utvecklare arbetar med ett stort antal projekt är det också möjligt att lägga till ett Azure Artifacts-flöde till det globala NuGet.config på varje utvecklares dator. I dessa situationer replikerar du den här konfigurationen Feeds I select here med hjälp av alternativet i NuGet-aktiviteten.

Felsökning

Projektet med Entity Framework har slutat fungera på värdbaserade agenter

.NET Core har inte entitetsramverk (EF) inbyggt. Du måste antingen installera EF innan du påbörjar körningen eller lägga till global.json i projektet med nödvändig .NET Core SDK-version. Detta säkerställer att rätt SDK används för att skapa EF-projekt. Om den version som krävs inte finns på datorn lägger du till uppgiften i UseDotNetV2 pipelinen för att installera den version som krävs. Mer information finns i Hämta Entity Framework Core-körningen.

Exempel

• Skapa exempel
• Push-exempel
• Push-exempel
• Paketexempel
• Publicera exempel
• Återställningsexempel
• Testexempel

Skapa exempel

Skapa ett projekt

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

Skapa flera projekt

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

Push-exempel

Skicka NuGet-paket till intern feed

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

Skicka NuGet-paket till extern feed

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

Paketexempel

Packa en NuGetPackage till en specifik utdatakatalog

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

Packa ett symbolpaket

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

Publicera exempel

Publicera projekt till angiven mapp

# 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

Återställningsexempel

#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

Testexempel

Köra tester på din lagringsplats

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

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent
Krav	Ingen
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	2.144.0 eller senare
Uppgiftskategori	Build