生成、测试和部署 .NET Core 项目

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

本文介绍如何使用 Azure Pipelines 来处理 .NET Core 项目。 本文将指导你完成以下任务：

先决条件

创建 .NET 项目并将其上传到 GitHub

如果想要在 GitHub 存储库中使用 .NET 项目，可以跳过本部分。

如果没有要使用的 .NET 项目，请在本地计算机上创建一个新项目，如下所示：

1. 安装 .NET 8.0 SDK，或确保已安装它。
2. 在本地计算机上打开终端窗口。
3. 创建项目目录，然后转到此目录。
4. 通过运行 dotnet new webapp -f net8.0创建新的 .NET 8 Web 应用。
5. 使用 dotnet run.. 在本地生成并运行应用程序。
6. 应用程序启动时，按 Ctrl+C 将其关闭。
7. 将本地项目上载或连接到 GitHub 存储库。

创建管道

如果有要使用的管道，可以跳过本部分。 否则，可以使用 YAML 管道编辑器或经典编辑器创建管道，如下所示：

现在，你已准备好一个可自定义的工作管道。

设置生成环境

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

还原依赖项

NuGet 包是项目依赖未生成的代码的一种方式。 可以通过通过 dotnet restore 任务或管道中的脚本运行DotNetCoreCLI@2命令来下载 NuGet 包和特定于项目的工具。 该 dotnet restore 命令使用打包到 .NET Core SDK 中的 NuGet.exe ，并且只能还原 .NET Core 项目 *.csproj 文件中指定的包。

可以使用 .NET Core （DotNetCoreCLI@2） 任务从 Azure Artifacts、NuGet.org 或其他经过身份验证的外部或内部 NuGet 存储库下载和还原 NuGet 包。 如果 NuGet 源与管道位于同一项目中，则无需进行身份验证。 有关详细信息，请参阅 .NET Core 任务 (DotNetCoreCLI@2)。

以下管道使用 DotNetCoreCLI@2 任务还原 Azure Artifact 源。

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

在 .NET Core SDK 版本 2.0 及更新版本中，运行命令（例如 dotnet build）时，包会自动还原。 如果使用经过身份验证的源，仍需要使用 .NET Core （DotNetCoreCLI@2） 任务来还原包。

通过在项目设置>管道服务连接中创建 NuGet 服务连接来管理经过身份验证的源>凭据。 有关 NuGet 服务连接的详细信息，请参阅 使用 Azure Pipelines 发布 NuGet 包。

从 NuGet.org 还原包

若要从 NuGet.org 还原包，请按如下所示更新管道。

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

从外部源还原包

若要指定外部 NuGet 存储库，请将 URL 放在存储库中的 NuGet.config 文件中。 请确保 NuGet.config 文件中指定了任何自定义源，并在 NuGet 服务连接中指定了凭据。

若要从外部源还原包，请按上一节中的说明添加 restore 任务，但按如下所示更改配置设置：

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>

还原 .NET Framework 项目的包

如果解决方案中还有Microsoft .NET Framework 项目或使用 package.json 指定依赖项，请使用 NuGetCommand@2 任务还原这些依赖项。

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

生成项目

通过运行 dotnet build 命令生成 .NET Core 项目。 可以使用 .NET Core （DotNetCoreCLI@2） 任务或命令行脚本将命令添加到管道。

使用 .NET Core 任务

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

使用命令行脚本生成 .NET Core

还可以使用命令行脚本进行生成。

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

将其他 .NET SDK 命令添加到管道

可以使用 .NET Core （DotNetCoreCLI@2） 任务或脚本将其他 .NET SDK 命令添加到管道。

使用 .NET Core 任务添加 .NET CLI 命令

使用 .NET Core （DotNetCoreCLI@2） 任务，可以轻松地将 .NET CLI 命令添加到管道。 可以通过编辑 YAML 文件或使用经典编辑器来添加 .NET Core （DotNetCoreCLI@2） 任务。

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

安装工具

若要在 Windows 上运行的版本中安装 .NET Core 全局工具（如 dotnetsay ），请添加 .NET Core 任务并在配置中设置以下属性：

• 命令： 自定义
• 项目路径：留空
• 自定义命令： tool
• 参数： install -g dotnetsay

若要运行该工具，请添加命令行任务并在dotnetsay”字段中输入。

运行测试

在存储库中有测试项目时，可以使用 .NET Core （DotNetCoreCLI@2） 任务通过 MSTest、xUnit 和 NUnit 等测试框架来运行单元测试。 测试项目必须引用 Microsoft.NET.Test.SDK 版本 15.8.0 或更高版本。

测试结果会自动发布到服务，可在生成摘要中获取。 可以使用测试结果对失败的测试进行故障排除，并分析测试计时。

若要将测试任务添加到管道，请将以下代码片段添加到 azure-pipelines.yml 文件：

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

如果使用任务助手添加 .NET Core （DotNetCoreCLI@2） 任务，请设置以下属性：

• 命令： 测试
• 项目路径：设置为解决方案中的测试项目
• 参数： --configuration $(BuildConfiguration)

或者，可以使用特定的记录器运行 dotnet test 命令，然后使用 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'

收集代码覆盖率

在 Windows 平台上生成时，可以使用内置覆盖率数据收集器来收集代码覆盖率指标。 测试项目必须引用 Microsoft.NET.Test.SDK 版本 15.8.0 或更高版本。

使用 .NET Core （DotNetCoreCLI@2） 任务运行测试时，覆盖率数据会自动发布到服务器。 可以从生成摘要下载 *.coverage 文件，以在 Visual Studio 中查看。

若要收集代码覆盖率，请在将测试任务添加到管道时添加 --collect "Code Coverage" 参数。

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

如果使用任务助手添加 .NET Core （DotNetCoreCLI@2） 任务，请设置以下属性：

• 命令： 测试
• 项目路径：设置为解决方案中的测试项目
• 参数： --configuration $(BuildConfiguration) --collect "Code Coverage"

确保发布测试结果选项保持选中状态。

或者，若要使用 dotnet test 具有特定记录器的命令来收集代码覆盖率结果，然后运行 PublishTestResults@2 任务，请使用以下代码：

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'

使用 Coverlet 收集代码覆盖率指标

如果在 Linux 或 macOS 上生成，则可以使用 Coverlet 或类似工具来收集代码覆盖率指标。

可以使用 发布代码覆盖率结果（PublishCodeCoverageResults@2）任务将代码覆盖率 结果发布到服务器。 必须配置覆盖率工具以 Cobertura 或 JaCoCo 覆盖率格式生成结果。

若要使用 Coverlet 运行测试和发布代码覆盖率，

1. 添加对 coverlet.collector NuGet 包的引用。
2. 将以下代码片段添加到 azure-pipelines.yml 文件：

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

打包和交付代码

若要打包和交付生成输出，可以：

• 将生成项目发布到 Azure Pipelines。
• 创建 NuGet 包并将其发布到 NuGet 源。
• 将 NuGet 包发布到 Azure Artifacts。
• 创建 ZIP 存档以部署到 Web 应用。
• 将符号发布到 Azure Artifacts 符号服务器或文件共享。

还可为应用生成映像，并将其推送到容器注册表。

将工件发布到 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'

有关详细信息，请参阅发布和下载生成项目。

发布到 NuGet 源

若要创建 NuGet 包并将其发布到 NuGet 源，请将以下代码片段添加到 azure-pipelines.yml 文件：

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

有关版本控制和发布 NuGet 包的详细信息，请参阅 使用 Azure Pipelines 发布 NuGet 包。

将 NuGet 包发布到 Azure Artifacts

可以使用 NuGetCommand@2 任务将 NuGet 包发布到 Azure Artifacts 源。 有关详细信息，请参阅 使用 Azure Pipelines 发布 NuGet 包。

将 ZIP 文件存档发布到 Web 应用

若要创建准备发布到 Web 应用的 ZIP 文件存档，请添加以下代码片段以 azure-pipelines.yml。 在生成应用后运行此任务，在大多数情况下接近管道的末尾。 例如，在部署到 Windows 上的 Azure Web 应用之前运行此任务。

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

要将此存档发布到 Web 应用，请参阅 Azure Web 应用部署。

发布符号

可以使用该 PublishSymbols@2 任务将符号发布到 Azure Artifacts 符号服务器或文件共享。 有关详细信息，请参阅发布符号。

例如，若要将符号发布到文件共享，请将以下代码片段添加到 azure-pipelines.yml 文件中：

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

若要使用经典编辑器，请将 索引源和发布符号 任务添加到管道。

故障排除

如果项目在本地计算机上成功生成，但不在本地管道中生成，请浏览以下潜在原因和纠正措施。

• 新版本的 .NET Core SDK 或 Visual Studio 可能会中断生成，例如，如果它包含 NuGet 工具的较新版本或功能。 请确保开发计算机上的 .NET Core SDK 版本和运行时与管道代理匹配。

  可以在 dotnet --version 管道中包含命令行脚本来打印 .NET Core SDK 的版本。 使用 .NET Core 工具安装程序 在代理上部署同一版本，或将项目和开发计算机更新为 .NET Core SDK 的管道版本。

• 由于从 NuGet.org 还原包时出现连接问题，生成可能会间歇性失败。NuGet.org 可能存在问题，或者 Azure 数据中心与 NuGet.org 之间可能存在网络问题。可以探索是否将 Azure Artifacts 与 上游源 配合使用来缓存包，从而提高生成的可靠性。

  管道的凭据自动用于连接到 Azure Artifacts。 这些凭据通常派生自项目集合生成服务帐户。 若要详细了解如何使用 Azure Artifacts 来缓存 NuGet 包，请参阅连接到 Azure Artifact 源。

• 你可能在 Visual Studio 中使用一些未在管道中编码的逻辑。 Azure Pipelines 在新进程中按顺序运行任务中的每个命令。 检查管道生成的日志，以查看在生成中运行的确切命令。 若要解决此问题，请在开发计算机上按相同顺序重复相同的命令。

• 如果混合解决方案包含一些 .NET Core 项目和一些 .NET Framework 项目，请使用 NuGet 任务还原 packages.config 文件中指定的包。 添加 MSBuild 或 Visual Studio 生成任务以生成 .NET Framework 项目。

相关内容

• Azure Artifacts
• 生成和发布任务
• .NET Core CLI 工具
• .NET Core 项目中的单元测试