Skapa, testa och distribuera .NET Core-projekt

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022 | Azure DevOps Server 2020

Den här artikeln beskriver hur du använder Azure Pipelines för att arbeta med .NET Core-projekt. Artikeln beskriver följande uppgifter:

Förutsättningar

Skapa ett .NET-projekt och ladda upp det till GitHub

Om du redan vill använda ett .NET-projekt på din GitHub-lagringsplats kan du hoppa över det här avsnittet.

Om du inte har något .NET-projekt att arbeta med skapar du ett nytt på den lokala datorn enligt följande:

1. Installera .NET 8.0 SDK eller kontrollera att det är installerat.
2. Öppna ett terminalfönster på den lokala datorn.
3. Skapa en projektkatalog och navigera till den.
4. Skapa en ny .NET 8-webbapp genom att köra dotnet new webapp -f net8.0.
5. Skapa och kör programmet lokalt med hjälp dotnet runav .
6. När programmet startar trycker du på Ctrl+C för att stänga av det.
7. Ladda upp eller anslut det lokala projektet till din GitHub-lagringsplats.

Skapa en processkedja

Om du har en pipeline som du vill använda kan du hoppa över det här avsnittet. Annars kan du använda YAML-pipelineredigeraren eller den klassiska redigeraren för att skapa en pipeline på följande sätt:

Nu har du en fungerande pipeline som är redo att anpassa.

Konfigurera din byggmiljö

steps:
- task: UseDotNet@2
  inputs:
    version: '8.x'

steps:
- task: UseDotNet@2
  displayName: 'Install .NET Core SDK'
  inputs:
    version: 8.x
    performMultiLevelLookup: true
    includePreviewVersions: true # Required for preview versions

pool:
  name: myPrivateAgents
  demands:
  - agent.os -equals Darwin
  - anotherCapability -equals somethingElse

pool:
  vmImage: 'ubuntu-latest' 

steps:
- task: UseDotNet@2
  inputs:
    version: '5.x'

steps:
- task: UseDotNet@2
  displayName: 'Install .NET Core SDK'
  inputs:
    version: 8.x
    performMultiLevelLookup: true
    includePreviewVersions: true # Required for preview versions

Återställa beroenden

NuGet-paket är ett sätt för projektet att vara beroende av kod som du inte skapar. Du kan ladda ned NuGet-paket och projektspecifika verktyg genom att köra dotnet restore kommandot, antingen via .NET Core-aktiviteten (DotNetCoreCLI@2) eller som ett skript i pipelinen. Kommandot dotnet restore använder NuGet.exe paketerade med .NET Core SDK och kan bara återställa paket som anges i .NET Core-projektet *.csproj-filer .

Du kan använda uppgiften .NET Core (DotNetCoreCLI@2) för att ladda ned och återställa NuGet-paket från Azure Artifacts, NuGet.org eller en annan autentiserad extern eller intern NuGet-lagringsplats. Om NuGet-feeden finns i samma projekt som din pipeline behöver du inte autentisera. Mer information finns i .NET Core-uppgift (DotNetCoreCLI@2).

Följande pipeline använder uppgiften DotNetCoreCLI@2 för att återställa en Azure Artifact-feed.

trigger:
- main

pool:
  vmImage: 'windows-latest'

steps:
- task: UseDotNet@2
  displayName: 'Install .NET Core SDK'
  inputs:
    version: 8.x
    performMultiLevelLookup: true
    includePreviewVersions: true # Required for preview versions

variables:
  buildConfiguration: 'Release'

steps:
- task: DotNetCoreCLI@2
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    vstsFeed: 'my-vsts-feed' # A series of numbers and letters

- task: DotNetCoreCLI@2
  inputs:
    command: 'build'
    arguments: '--configuration $(buildConfiguration)'
  displayName: 'dotnet build $(buildConfiguration)'

I .NET Core SDK version 2.0 och senare återställs paket automatiskt när du kör kommandon som dotnet build. Du måste fortfarande använda .NET Core-uppgiften (DotNetCoreCLI@2) för att återställa paket om du använder en autentiserad feed.

Hantera autentiseringsuppgifterna för en autentiserad feed genom att skapa en NuGet-tjänstanslutning iAnslutningar för Pipelines-tjänsten för>projektinställningar>. Mer information om NuGet-tjänstanslutningar finns i Publicera NuGet-paket med Azure Pipelines.

Återställa paket från NuGet.org

Om du vill återställa paket från NuGet.org uppdaterar du pipelinen på följande sätt.

steps:
- task: DotNetCoreCLI@2
  displayName: Restore
  inputs:
    command: restore
    projects: '**/*.csproj'
    feedsToUse: select

Återställa paket från en extern feed

Om du vill ange en extern NuGet-lagringsplats placerar du URL:en i en NuGet.config-fil på lagringsplatsen. Kontrollera att alla anpassade feeds har angetts i filenNuGet.config och att autentiseringsuppgifterna anges i en NuGet-tjänstanslutning.

Om du vill återställa paket från en extern feed lägger du till restore uppgiften enligt instruktionerna i föregående avsnitt, men ändrar konfigurationsinställningarna enligt följande:

steps:
- task: DotNetCoreCLI@2
  displayName: Restore
  inputs:
    command: restore
    projects: '**/*.csproj'
    feedsToUse: config
    nugetConfigPath: NuGet.config    # Relative to root of the repository
    externalFeedCredentials: <NuGet service connection>

Återställa paket för .NET Framework-projekt

Om du också har ett Microsoft .NET Framework-projekt i din lösning eller använder package.json för att ange dina beroenden använder du uppgiften NuGetCommand@2 för att återställa dessa beroenden.

- task: NuGetCommand@2
  inputs:
    command: 'restore'
    restoreSolution: '**/*.sln'
    feedsToUse: 'select'

Skapa projektet

Skapa ditt .NET Core-projekt genom att dotnet build köra kommandot . Du kan lägga till kommandot i pipelinen med hjälp av .NET Core-aktiviteten (DotNetCoreCLI@2) eller som ett kommandoradsskript.

Använda .NET Core-uppgiften

steps:
- task: DotNetCoreCLI@2
  displayName: Build
  inputs:
    command: build
    projects: '**/*.csproj'
    arguments: '--configuration $(buildConfiguration)'

Skapa .NET Core med ett kommandoradsskript

Du kan också skapa med hjälp av ett kommandoradsskript.

steps:
- script: dotnet build --configuration $(buildConfiguration)
  displayName: 'dotnet build $(buildConfiguration)'

Lägg till andra .NET SDK-kommandon i pipelinen

Du kan lägga till andra .NET SDK-kommandon i pipelinen med hjälp av .NET Core-aktiviteten (DotNetCoreCLI@2) eller som skript.

Lägg till ett .NET CLI-kommando med .NET Core-uppgiften

Med uppgiften .NET Core (DotNetCoreCLI@2) kan du enkelt lägga till .NET CLI-kommandon i pipelinen. Du kan lägga till .NET Core-uppgifter (DotNetCoreCLI@2) genom att redigera YAML-filen eller med hjälp av den klassiska redigeraren.

steps:
# ...
- script: dotnet test <test-project> 

Installera ett verktyg

Om du vill installera ett globalt .NET Core-verktyg som dotnetsay i en version som körs i Windows lägger du till en .NET Core-uppgift och anger följande egenskaper i konfigurationen:

• Kommando: anpassad
• Sökväg till projekt: lämna tom
• Anpassat kommando: tool
• Argument: install -g dotnetsay

Om du vill köra verktyget lägger du till en kommandoradsaktivitet och anger dotnetsay i fältet Skript .

Kör dina tester

När du har testprojekt på lagringsplatsen kan du använda .NET Core-uppgiften (DotNetCoreCLI@2) för att köra enhetstester med hjälp av testramverk som MSTest, xUnit och NUnit. Testprojektet måste referera till Microsoft.NET.Test.SDK version 15.8.0 eller senare.

Testresultat publicerar automatiskt till tjänsten och är tillgängliga för dig i byggsammanfattningen. Du kan använda testresultaten för att felsöka misslyckade tester och analysera testtid.

Om du vill lägga till en testuppgift i pipelinen lägger du till följande kodfragment i filen azure-pipelines.yml :

steps:
# ...
# do this after other tasks such as build
- task: DotNetCoreCLI@2
  inputs:
    command: test
    projects: '**/*Tests/*.csproj'
    arguments: '--configuration $(buildConfiguration)'

Om du använder aktivitetsassistenten för att lägga till .NET Core-aktiviteten (DotNetCoreCLI@2) anger du följande egenskaper:

• Kommando: test
• Sökväg till projekt: Ange till testprojekten i din lösning
• Argument: --configuration $(BuildConfiguration)

Du kan också köra dotnet test kommandot med en specifik logger och sedan använda uppgiften PublishTestResults@2 :

steps:
# ...
# do this after your tests run
- script: dotnet test <test-project> --logger trx
- task: PublishTestResults@2
  condition: succeededOrFailed()
  inputs:
    testRunner: VSTest
    testResultsFiles: '**/*.trx'

Samla in kodtäckning

När du bygger på Windows-plattformen kan du samla in kodtäckningsmått med hjälp av den inbyggda datainsamlaren för täckning. Testprojektet måste referera till Microsoft.NET.Test.SDK version 15.8.0 eller senare.

När du använder .NET Core-aktiviteten (DotNetCoreCLI@2) för att köra tester publiceras täckningsdata automatiskt till servern. Du kan ladda ned filen *.coverage från byggsammanfattningen för att visa den i Visual Studio.

Om du vill samla in kodtäckning lägger du till --collect "Code Coverage" argumentet när du lägger till testaktiviteten i pipelinen.

steps:
# ...
# do this after other tasks such as build
- task: DotNetCoreCLI@2
  inputs:
    command: test
    projects: '**/*Tests/*.csproj'
    arguments: '--configuration $(buildConfiguration) --collect "Code Coverage"'

Om du använder aktivitetsassistenten för att lägga till .NET Core-aktiviteten (DotNetCoreCLI@2) anger du följande egenskaper:

• Kommando: test
• Sökväg till projekt: Ange till testprojekten i din lösning
• Argument: --configuration $(BuildConfiguration) --collect "Code Coverage"

Kontrollera att alternativet Publicera testresultat förblir markerat.

Om du vill samla in kodtäckningsresultat med hjälp dotnet test av kommandot med en specifik logger och sedan köra PublishTestResults@2 uppgift använder du följande kod:

steps:
# ...
# do this after your tests run
- script: dotnet test <test-project> --logger trx --collect "Code Coverage"
- task: PublishTestResults@2
  inputs:
    testRunner: VSTest
    testResultsFiles: '**/*.trx'

Samla in kodtäckningsmått med Coverlet

Om du bygger på Linux eller macOS kan du använda Coverlet eller ett liknande verktyg för att samla in kodtäckningsmått.

Du kan publicera kodtäckningsresultat till servern med uppgiften Publicera kodtäckningsresultat (PublishCodeCoverageResults@2). Du måste konfigurera täckningsverktyget för att generera resultat i Cobertura- eller JaCoCo-täckningsformat.

Så här kör du tester och publicerar kodtäckning med Coverlet:

1. Lägg till en referens till coverlet.collector NuGet-paketet.
2. Lägg till följande kodfragment i din azure-pipelines.yml-fil :

- task: DotNetCoreCLI@2
  displayName: 'dotnet test'
  inputs:
    command: 'test'
    arguments: '--configuration $(buildConfiguration) --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura'
    publishTestResults: true
    projects: '<test project directory>'
  
- task: PublishCodeCoverageResults@2
  displayName: 'Publish code coverage report'
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: '$(Agent.TempDirectory)/**/coverage.cobertura.xml'

Paketera och leverera din kod

Om du vill paketera och leverera byggutdata kan du:

• Publicera dina byggartefakter till Azure Pipelines.
• Skapa ett NuGet-paket och publicera det till din NuGet-feed.
• Publicera ditt NuGet-paket till Azure Artifacts.
• Skapa ett ZIP-arkiv för att distribuera till en webbapp.
• Publicera symboler till en Azure Artifacts-symbolserver eller en filresurs.

Du kan också skapa en avbildning för din app och skicka den till ett containerregister.

Publicera artefakter till Azure Pipelines

steps:

- task: DotNetCoreCLI@2
  inputs:
    command: publish
    publishWebProjects: True
    arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
    zipAfterPublish: True

- task: PublishPipelineArtifact@1
  inputs:
    targetPath: '$(Build.ArtifactStagingDirectory)' 
    artifactName: 'myWebsite'

steps:

- task: DotNetCoreCLI@2
  inputs:
    command: publish
    publishWebProjects: true
    arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
    zipAfterPublish: True

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)'
    ArtifactName: 'drop'

Mer information finns i Publicera och ladda ned byggartefakter.

Publicera till en NuGet-feed

Om du vill skapa ett NuGet-paket och publicera det i Din NuGet-feed lägger du till följande kodfragment i din azure-pipelines.yml-fil :

steps:
# ...
# do this near the end of your pipeline
- script: dotnet pack /p:PackageVersion=$(version)  # define the version variable elsewhere in your pipeline
- task: NuGetAuthenticate@1
  inputs:
    nuGetServiceConnections: '<NuGet service connection>'
- task: NuGetCommand@2
  inputs:
    command: push
    nuGetFeedType: external
    publishFeedCredentials: '<NuGet service connection>'
    versioningScheme: byEnvVar
    versionEnvVar: version

Mer information om versionshantering och publicering av NuGet-paket finns i Publicera NuGet-paket med Azure Pipelines.

Publicera ett NuGet-paket till Azure Artifacts

Du kan publicera dina NuGet-paket i Azure Artifacts-flödet med hjälp av NuGetCommand@2 uppgift. Mer information finns i Publicera NuGet-paket med Azure Pipelines.

Publicera ett ZIP-filarkiv till en webbapp

Om du vill skapa ett ZIP-filarkiv som är redo att publiceras i en webbapp lägger du till följande kodfragment i azure-pipelines.yml. Kör den här uppgiften när du har skapat din app, i de flesta fall i slutet av pipelinen. Kör till exempel den här uppgiften innan du distribuerar till en Azure-webbapp i Windows.

steps:
# ...
- task: DotNetCoreCLI@2
  inputs:
    command: publish
    publishWebProjects: True
    arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
    zipAfterPublish: True

Information om hur du publicerar det här arkivet till en webbapp finns i Distribution av Azure Web Apps.

Publicera symboler

Du kan använda uppgiften PublishSymbols@2 för att publicera symboler till en Azure Artifacts-symbolserver eller en filresurs. Mer information finns i Publicera symboler.

Om du till exempel vill publicera symboler till en filresurs lägger du till följande kodfragment i din azure-pipelines.yml-fil :

- task: PublishSymbols@2
  inputs:
    SymbolsFolder: '$(Build.SourcesDirectory)'
    SearchPattern: '**/bin/**/*.pdb'
    IndexSources: true
    PublishSymbols: true
    SymbolServerType: 'FileShare' 
    SymbolsPath: '\\<server>\<shareName>'

Om du vill använda den klassiska redigeraren lägger du till uppgiften Indexkällor och publicerar symboler i pipelinen.

Felsökning

Om projektet har skapats på den lokala datorn men inte i Azure Pipelines kan du utforska följande potentiella orsaker och korrigerande åtgärder.

• En ny version av .NET Core SDK eller Visual Studio kan bryta versionen, till exempel om den innehåller en nyare version eller funktion i NuGet-verktyget. Kontrollera att .NET Core SDK-versionerna och körningen på utvecklingsdatorn matchar pipelineagenten.

  Du kan inkludera ett dotnet --version kommandoradsskript i pipelinen för att skriva ut versionen av .NET Core SDK. Använd antingen installationsprogrammet för .NET Core-verktyget för att distribuera samma version på agenten eller uppdatera projekt- och utvecklingsdatorn till pipelineversionen av .NET Core SDK.

• Dina versioner kan misslyckas tillfälligt på grund av anslutningsproblem när du återställer paket från NuGet.org. NuGet.org kan ha problem, eller så kan det finnas nätverksproblem mellan Azure-datacentret och NuGet.org. Du kan utforska om användning av Azure Artifacts med överordnade källor för att cachelagrar paketen förbättrar tillförlitligheten för dina versioner.

  Autentiseringsuppgifterna för pipelinen används automatiskt för att ansluta till Azure Artifacts. Dessa autentiseringsuppgifter härleds vanligtvis från Project Collection Build Service-kontot . Mer information om hur du använder Azure Artifacts för att cachelagrar dina NuGet-paket finns i Ansluta till Azure Artifact-feeds.

• Du kanske använder viss logik i Visual Studio som inte är kodad i din pipeline. Azure Pipelines kör varje kommando i en uppgift sekventiellt i en ny process. Granska loggarna från pipelines-versionen för att se de exakta kommandona som kördes i bygget. Om du vill hitta problemet upprepar du samma kommandon i samma ordning på utvecklingsdatorn.

• Om du har en blandad lösning som innehåller vissa .NET Core-projekt och vissa .NET Framework-projekt använder du NuGet-uppgiften för att återställa paket som anges i packages.config-filerna . Lägg till uppgiften MSBuild eller Visual Studio Build för att skapa .NET Framework-projekten.

Relaterat innehåll

• Azure Artifacts
• Bygg- och versionsaktiviteter
• .NET Core CLI-verktyg
• Enhetstestning i .NET Core-projekt