Validate API compatibility with Microsoft.DotNet.ApiCompat

Author: 0xced

NuGet.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+    <packageSources>
+        <!-- For Microsoft.DotNet.ApiCompat -->
+        <add key=".NET Core Tools" value="https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json" />
+    </packageSources>
+</configuration>

packages.lock.json

@@ -2,6 +2,12 @@
   "version": 1,
   "dependencies": {
     ".NETStandard,Version=v2.0": {
+      "Microsoft.DotNet.ApiCompat": {
+        "type": "Direct",
+        "requested": "[7.0.0-*, )",
+        "resolved": "7.0.0-beta.21463.4",
+        "contentHash": "TbIGBfVrAqVDA3a8H2V7RtLFJg5AWhIHL3DHFO4SWAAzEhNwUdTqk0j6etl2nKaY5jalC3xk90DuRME/NG6FOw=="
+      },
       "Microsoft.SourceLink.GitHub": {
         "type": "Direct",
         "requested": "[1.0.0, )",

src/ApiCompatBaseline.txt

@@ -0,0 +1,11 @@
+Compat issues with assembly Serilog.Formatting.Log4Net:
+TypesMustExist : Type 'Serilog.Formatting.Log4Net.LineEndingExtensions' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public Serilog.Formatting.Log4Net.CDataMode Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.CDataMode.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public Serilog.Formatting.Log4Net.PropertyFilter Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.FilterProperty.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public Serilog.Formatting.Log4Net.ExceptionFormatter Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.FormatException.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public System.IFormatProvider Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.FormatProvider.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public Serilog.Formatting.Log4Net.IndentationSettings Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.IndentationSettings.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public Serilog.Formatting.Log4Net.LineEnding Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.LineEnding.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public System.Xml.XmlQualifiedName Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.Log4NetXmlNamespace.get()' does not exist in the implementation but it does exist in the contract.
+MembersMustExist : Member 'public Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder Serilog.Formatting.Log4Net.Log4NetTextFormatterOptionsBuilder.UseLog4NetXmlNamespace(System.Xml.XmlQualifiedName)' does not exist in the implementation but it does exist in the contract.
+Total Issues: 9

src/Serilog.Formatting.Log4Net.csproj

@@ -49,11 +49,27 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.DotNet.ApiCompat" Version="7.0.0-*" PrivateAssets="all" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="all" />
     <PackageReference Include="MinVer" Version="2.5.0" PrivateAssets="all" />
     <PackageReference Include="Serilog" Version="2.0.0" />
   </ItemGroup>
 
+  <!-- Run `dotnet build -p:BaselineAllAPICompatError=true` to accept breaking changes
+       See https://stu.dev/check-for-breaking-changes-with-apicompat/ for more information -->
+  <Target Name="SetupResolvedMatchingContract" BeforeTargets="ValidateApiCompatForSrc">
+    <PropertyGroup>
+      <ContractVersion>1.0.0-rc.2</ContractVersion>
+      <ContractFilePath>$([System.IO.Path]::Combine($(NuGetPackageRoot),$(PackageId.ToLowerInvariant()),$(ContractVersion),'lib',$(TargetFramework),$(TargetFileName)))</ContractFilePath>
+    </PropertyGroup>
+    <ItemGroup>
+      <ResolvedMatchingContract Include="$(ContractFilePath)" />
+    </ItemGroup>
+    <!--  We don't really want to validate the package here but `dotnet validate package remote ...` downloads and extract the NuGet package into the NuGet package root -->
+    <Exec Command="dotnet tool restore" Condition="!Exists($(ContractFilePath))" />
+    <Exec Command="dotnet validate package remote $(PackageId) --version $(ContractVersion)" StandardOutputImportance="low" IgnoreExitCode="true" Condition="!Exists($(ContractFilePath))" />
+  </Target>
+
   <Target Name="ValidateNuGetPackage" AfterTargets="Pack">
     <!-- For reference: the file `.config/dotnet-tools.json` was created by running `dotnet new tool-manifest && dotnet tool install dotnet-validate` -->
     <Exec Command="dotnet tool restore" />