Azure Pipeline发布NuGet包到Azure Artifact后无法调试问题排查

问题产生原因 #

• 项目未正确配置Source Link相关依赖和属性：仅配置Visual Studio侧的调试选项不足以实现源码调试，还需要在类库项目中添加Source Link的NuGet包并开启对应的构建属性
• PublishSymbols@2任务配置缺陷：默认配置未适配.NET Core的便携PDB格式，且如果任务执行顺序早于dotnet pack/构建完成步骤，会导致无法正确捕获生成的PDB文件
• NuGet包构建时未包含调试信息或PDB格式不兼容：Release模式下默认可能禁用调试信息输出，或者生成的PDB格式与符号服务器要求不匹配
• Visual Studio符号加载配置不全：仅完成Source Link配置，未将对应Azure DevOps组织的符号服务器添加到VS的符号源列表，导致无法拉取对应版本的符号文件
• 符号版本与NuGet包版本不匹配：若多次构建同一版本号的包，会导致符号服务器存储的PDB与实际安装的NuGet包内的程序集版本不对应，无法加载符号

解决方案 #

第一步：调整类库项目配置 #

在你的.NET Core 3.1类库项目中添加与代码托管平台对应的Source Link NuGet包：代码存放在GitHub则安装Microsoft.SourceLink.GitHub，存放在Azure Repos则安装Microsoft.SourceLink.AzureRepos.Git，选择适配.NET Core 3.1的最新稳定版即可。
之后在项目文件(.csproj)的PropertyGroup节点中添加以下属性：

<DebugType>portable</DebugType>
<DebugSymbols>true</DebugType>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<EmbedUntrackedSources>true</EmbedUntrackedSources>

构建时会生成兼容的便携PDB，同时附带Source Link需要的仓库关联信息。

第二步：调整Azure Pipeline YAML配置 #

首先调整任务执行顺序：确保PublishSymbols@2任务在dotnet build、dotnet pack任务之后运行。
然后更新PublishSymbols@2任务配置，添加便携PDB支持参数：

- task: PublishSymbols@2
  inputs:
    SearchPattern: '**/bin/**/*.pdb'
    SymbolServerType: 'TeamServices'
    IndexSources: true
    PublishSymbols: true
    TreatNotIndexedAsWarning: true
  continueOnError: false

如果你的构建输出目录不是默认的bin目录，需要同步修改SearchPattern匹配对应的PDB存放路径。
另外在dotnet pack任务中，可以选择将PDB直接打包到nupkg内作为备选方案，添加参数--include-symbols -p:SymbolPackageFormat=snupkg，生成对应的符号包同步推送到Azure Artifact feed，需要提前确认你的Artifact feed已开启符号包支持。

第三步：校验Visual Studio调试配置 #

1. 打开VS的「工具」-「选项」-「调试」-「常规」，确认以下选项配置正确：
   • 勾选「启用源链接支持」
   • 取消勾选「仅启用我的代码」
   • 取消勾选「要求源文件与原始版本完全匹配」
2. 进入「调试」-「符号」，添加你的Azure DevOps组织对应的符号服务器源，确认勾选该符号源，同时配置本地符号缓存目录可正常写入。
3. 调试项目时，打开「模块」窗口，确认对应的类库程序集的符号状态为「已加载」，如果未加载可以手动右键选择加载符号，从对应符号服务器路径查找。

第四步：校验版本匹配 #

确保每次发布的NuGet包使用唯一的版本号，避免重复构建同一版本号导致符号与程序集不匹配的问题。

内容的提问来源于stack exchange，提问作者David Mosyan