根据基线包版本进行验证

包验证可帮助你根据之前发布的稳定版包来验证库项目。 若要启用包验证,请将 PackageValidationBaselineVersionPackageValidationBaselinePath 属性添加到项目文件。

包验证可检测针对任何已发布的目标框架的任何中断性变更。 它还会检测是否已删除任何目标框架支持。

例如,考虑以下情况。 你正在处理 AdventureWorks.Client NuGet 包,并且想要确保不会意外进行中断性变更。 你将项目配置为指示包验证工具针对早期版本的包运行 API 兼容性检查。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <PackageVersion>2.0.0</PackageVersion>
    <EnablePackageValidation>true</EnablePackageValidation>
    <PackageValidationBaselineVersion>1.0.0</PackageValidationBaselineVersion>
  </PropertyGroup>

</Project>

几周后,你的任务是为库添加对连接超时的支持。 Connect 方法目前如下所示:

public static HttpClient Connect(string url)
{
    // ...
}

由于连接超时是一个高级配置设置,因此你认为可以添加一个可选参数:

public static HttpClient Connect(string url, TimeSpan timeout = default)
{
    // ...
}

但是,当你尝试打包时,它将引发错误。

D:\demo>dotnet pack
Microsoft (R) Build Engine version 17.0.0-preview-21460-01+8f208e609 for .NET
Copyright (C) Microsoft Corporation. All rights reserved.

  Determining projects to restore...
  All projects are up-to-date for restore.
  You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
  PackageValidationThrough -> D:\demo\bin\Debug\net6.0\PackageValidationThrough.dll
  Successfully created package 'D:\demo\bin\Debug\PackageValidationThrough.2.0.0.nupkg'.
C:\Program Files\dotnet\sdk\6.0.100-rc.1.21463.6\Sdks\Microsoft.NET.Sdk\targets\Microsoft.NET.Compatibility.Common.targets(32,5): error CP0002: Member 'A.B.Connect(string)' exists on [Baseline] lib/net6.0/PackageValidationThrough.dll but not on lib/net6.0/PackageValidationThrough.dll [D:\demo\PackageValidationThrough.csproj]

BaselineVersion

你发现虽然这不是源中断性变更,但它是二进制中断性变更。 通过添加新的重载(而不是向现有方法添加参数)即可解决此问题:

public static HttpClient Connect(string url)
{
    return Connect(url, Timeout.InfiniteTimeSpan);
}

public static HttpClient Connect(string url, TimeSpan timeout)
{
    // ...
}

现在当你打包项目时,它就会成功。

BaselineVersionSuccessful