如何自动验证项目NuGet包是否使用最新版本并触发构建错误？

以下几种方案可以实现自动检查项目NuGet包是否为最新版本，并在存在更新时触发构建错误，同时支持Visual Studio内构建和命令行MSBuild构建场景：

方法一：使用dotnet outdated工具配合自定义MSBuild目标 #

dotnet outdated是官方推荐的NuGet包更新检查工具，可通过配置使其在构建前运行并在发现更新时返回错误码，中断构建。

1. 安装工具
   在命令行执行全局安装命令：

   dotnet tool install --global dotnet-outdated-tool
   

2. 添加MSBuild目标
   在解决方案根目录创建Directory.Build.props文件，添加以下内容：

   <Project>
     <Target Name="EnforceLatestNuGetPackages" BeforeTargets="Build">
       <!-- 检查解决方案内所有项目的NuGet包，存在更新时返回错误码1 -->
       <Exec Command="dotnet outdated $(SolutionDir) --exit-code 1 --include-prerelease false" 
             ContinueOnError="false" />
     </Target>
   </Project>
   

   • --exit-code 1：指定发现可用更新时工具返回非零错误码，触发MSBuild构建失败
   • --include-prerelease false：关闭预发布版本检查，按需改为true即可包含预发布包
   • 该文件会被所有项目自动加载，无论在VS内构建还是命令行执行dotnet build/msbuild都会生效

方法二：使用NuGet包分析器升级警告为错误 #

通过官方的NuGet包分析器，将“包不是最新版本”的提示从警告升级为错误，强制构建失败。

1. 安装分析器包
   在项目中安装分析器：

   dotnet add package Microsoft.VisualStudio.CodeAnalysis.Packages
   

2. 配置规则级别
   在项目根目录或解决方案目录创建.editorconfig文件，添加以下规则：

   # 将"存在可用的包更新"的诊断警告升级为错误
   dotnet_diagnostic.NU1006.severity = error
   

   • NU1006是分析器中对应“Package is not latest version”的诊断ID
   • 配置后，VS内构建和命令行构建时，只要存在未更新的NuGet包，就会以错误形式中断构建

方法三：自定义脚本配合MSBuild（灵活适配复杂场景） #

如果需要自定义忽略特定包、批量检查等逻辑，可以编写PowerShell脚本，通过MSBuild在构建前调用。

1. 编写检查脚本
   在解决方案根目录创建CheckNuGetUpdates.ps1脚本：

   $solutionPath = $args[0]
   # 获取所有过时的NuGet包信息
   $outdatedPackages = dotnet list $solutionPath package --outdated
   
   if ($outdatedPackages -match "\[Available\]") {
       Write-Error "发现可用的NuGet包更新，请升级后再构建：`n$outdatedPackages"
       exit 1
   }
   

2. 添加MSBuild目标
   在Directory.Build.props中添加以下目标：

   <Project>
     <Target Name="CheckNuGetVersions" BeforeTargets="Build">
       <Exec Command="powershell -ExecutionPolicy Bypass -File $(SolutionDir)CheckNuGetUpdates.ps1 $(SolutionDir)" 
             ContinueOnError="false" />
     </Target>
   </Project>
   

   • 可在脚本中扩展逻辑，比如添加忽略列表、过滤特定版本等

各方案对比 #

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