Switch to non-incremental servicing and update ApiCompatNetCoreAppBas…

…elineVersion to 9.0.0 (#109790) * Update ApiCompatNetCoreAppBaselineVersion to 9.0.0 * Switch to non-incremental servicing by manually backporting 824bdd2 from release/9.0 --------- Co-authored-by: Eric StJohn <[email protected]> * Result of running: dotnet build src/libraries/apicompat/ApiCompat.proj /p:ApiCompatGenerateSuppresionFile=true * Update suppression files * Update NetCoreAppLatestStabel suppression file --------- Co-authored-by: Viktor Hofer <[email protected]>
dotnet · Nov 20, 2024 · 5c218ab · 5c218ab
1 parent 0b8addb
commit 5c218ab
Show file tree

Hide file tree

Showing 10 changed files with 18 additions and 337 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md
@@ -22,6 +22,7 @@ main PR <!-- Link to PR if any that fixed this in the main branch. -->
 
 <!-- Please assess the risk of taking this fix. Provide details backing up your assessment. -->
 
-# Package authoring signed off?
+# Package authoring no longer needed in .NET 9
 
-IMPORTANT: If this change touches code that ships in a NuGet package, please make certain that you have added any necessary [package authoring](../../docs/project/library-servicing.md) and gotten it explicitly reviewed.
+IMPORTANT: Starting with .NET 9, you no longer need to edit a NuGet package's csproj to enable building and bump the version.
+Keep in mind that we still need package authoring in .NET 8 and older versions.
diff --git a/.github/workflows/backport.yml b/.github/workflows/backport.yml
@@ -48,4 +48,7 @@ jobs:
 
         - The PR target branch is `release/X.0-staging`, not `release/X.0`.
 
-        - If the change touches code that ships in a NuGet package, you have added the necessary [package authoring](https://github.com/dotnet/runtime/blob/main/docs/project/library-servicing.md) and gotten it explicitly reviewed.
+        ## Package authoring no longer needed in .NET 9
+
+        **IMPORTANT**: Starting with .NET 9, you no longer need to edit a NuGet package's csproj to enable building and bump the version.
+        Keep in mind that we still need package authoring in .NET 8 and older versions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -120,9 +120,7 @@
     <NetFrameworkToolCurrent Condition="'$(DotNetBuildSourceOnly)' == 'true'" />
     <NetFrameworkCurrent Condition="'$(DotNetBuildSourceOnly)' == 'true'" />
 
-    <!-- Important: Set this to the GA version (or a close approximation) during servicing and adjust the TFM property below. -->
-    <!-- TODO: Update to 9.0.0 when .NET 9 is generally available. https://github.com/dotnet/runtime/issues/106598 -->
-    <ApiCompatNetCoreAppBaselineVersion>9.0.0-preview.7.24405.7</ApiCompatNetCoreAppBaselineVersion>
+    <ApiCompatNetCoreAppBaselineVersion>9.0.0</ApiCompatNetCoreAppBaselineVersion>
     <ApiCompatNetCoreAppBaselineTFM>net9.0</ApiCompatNetCoreAppBaselineTFM>
   </PropertyGroup>
 

diff --git a/docs/project/library-servicing.md b/docs/project/library-servicing.md
@@ -4,21 +4,15 @@ This document provides the steps that need to be followed after modifying a libr
 
 Servicing branches represent shipped versions of .NET, and their name is in the format `release/X.0-staging`. Examples:
 
+- `release/9.0-staging`
 - `release/8.0-staging`
-- `release/7.0-staging`
-- `release/6.0-staging`
 
-## Check if a package is generated
-
-If a library is packable (check for the `<IsPackable>true</IsPackable>` property) you'll need to set `<GeneratePackageOnBuild>true</GeneratePackageOnBuild>` in the source project. That is necessary as packages aren't generated by default in servicing releases.
-
-## Determine ServiceVersion
-
-When you make a change to a library & ship it during the servicing release, the `ServicingVersion` must be bumped. This property is found in the library's source project. It's also possible that the property is not in that file, in which case you'll need to add it to the library's source project and set it to 1. If the property is already present in your library's source project, just increment the servicing version by 1.
+IMPORTANT: Starting with .NET 9, you no longer need to edit a NuGet package's csproj to enable building and bump the version.
+Keep in mind that we still need package authoring in .NET 8 and older versions.
 
 ## Test your changes
 
-All that's left is to ensure that your changes have worked as expected. To do so, execute the following steps:
+Develop and test your change as normal.  For packages, you may want to test them outside the repo infrastructure. To do so, execute the following steps:
 
 1. From a clean copy of your branch, run `build.cmd/sh libs -allconfigurations`
 
@@ -34,9 +28,8 @@ All the servicing change must go through an approval process. You have two ways
 - By manually creating your PR using [this template](https://raw.githubusercontent.com/dotnet/runtime/main/.github/PULL_REQUEST_TEMPLATE/servicing_pull_request_template.md).
 - Or by asking the bot to automatically create the servicing PR for you using a merged `main` PR as source. This method requires typing an AzDO backport command as a comment of your merged PR using the format `/backport to release/X.0-staging`. Examples:
 
+  - `/backport to release/9.0-staging`
   - `/backport to release/8.0-staging`
-  - `/backport to release/7.0-staging`
-  - `/backport to release/6.0-staging`
 
 For all cases, you must:
 
@@ -52,4 +45,4 @@ For all cases, you must:
 
 The area owner can then merge the PR once the CI looks good (it's either green or the failures are investigated and determined to be unrelated to the PR).
 
-**Note**: Applying the `Servicing-approved` label ensures the `check-service-labels` CI job passes, which is a mandatory requirement for merging a PR in a servicing branch.
+**Note**: Applying the `Servicing-approved` label ensures the `check-service-labels` CI job passes, which is a mandatory requirement for merging a PR in a servicing branch.
diff --git a/eng/packaging.targets b/eng/packaging.targets
@@ -27,8 +27,6 @@
     <PackageReadmeFilePath Condition="'$(PackageReadmeFilePath)' == '' and '$(EnableDefaultPackageReadmeFile)' == 'true'">PACKAGE.md</PackageReadmeFilePath>
     <BeforePack>$(BeforePack);ValidatePackageReadmeExists</BeforePack>
 
-    <!-- Non-shipping packages shouldn't incrementally serviced. -->
-    <PackageUseIncrementalServicingVersion Condition="'$(IsShipping)' != 'true'">false</PackageUseIncrementalServicingVersion>
     <!-- Generate packages for rid specific projects or for allconfigurations during build. -->
     <!-- A package isn't generated if in servicing or in runtimelab. Intended to be overridden at project level. -->
     <IsRIDSpecificProject Condition="$(MSBuildProjectName.StartsWith('runtime.')) and
@@ -37,15 +35,7 @@
                                         '$(BuildAllConfigurations)' == 'true' or
                                         '$(IsRIDSpecificProject)' == 'true'
                                        ) and
-                                       (
-                                        '$(PreReleaseVersionLabel)' != 'servicing' or
-                                        '$(PackageUseIncrementalServicingVersion)' != 'true'
-                                       ) and
                                        '$(GitHubRepositoryName)' != 'runtimelab'">true</GeneratePackageOnBuild>
-    <!-- When in source-build we need to generate all packages when building for all configurations even in servicing. -->
-    <GeneratePackageOnBuild Condition="'$(GeneratePackageOnBuild)' != 'true' and
-                                       '$(BuildAllConfigurations)' == 'true' and
-                                       '$(DotNetBuildSourceOnly)' == 'true'">true</GeneratePackageOnBuild>
 
     <!-- During NoBuild pack invocations, skip project reference build. Necessary for the IncludeProjectReferencesWithPackAttributeInPackage target. -->
     <BuildProjectReferences Condition="'$(NoBuild)' == 'true'">false</BuildProjectReferences>
@@ -58,18 +48,6 @@
     <NoWarn>$(NoWarn);CP0003</NoWarn>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(PreReleaseVersionLabel)' == 'servicing' and
-                            '$(PackageUseIncrementalServicingVersion)' == 'true'">
-    <!-- If no servicing version is set we need to default to 0 in order for dependency versions to
-    be calculated properly, if we don't set it to 0, we would get the dependency version using the
-    product Patch Version -->
-    <ServicingVersion Condition="'$(ServicingVersion)' == ''">0</ServicingVersion>
-
-    <!-- Always update the package version in servicing. -->
-    <Version>$(MajorVersion).$(MinorVersion).$(ServicingVersion)</Version>
-    <Version Condition="'$(VersionSuffix)' != ''">$(Version)-$(VersionSuffix)</Version>
-  </PropertyGroup>
-
   <ItemGroup>
     <!-- Add a marker to help the designer optimize & share .NET Core packages -->
     <None Include="$(PackageDesignerMarkerFile)"
@@ -327,14 +305,6 @@
     </ItemGroup>
   </Target>
 
-  <Target Name="ValidateServicingVersionIsProperlySet"
-          Condition="'$(PreReleaseVersionLabel)' == 'servicing' and
-                     '$(PackageUseIncrementalServicingVersion)' == 'true' and
-                     '$(DotNetBuildSourceOnly)' != 'true'"
-          AfterTargets="GenerateNuspec">
-    <Error Condition="'$(ServicingVersion)' == '0'" Text="ServicingVersion is set to 0 and it should be an increment of the patch version from the last released package." />
-  </Target>
-
   <Target Name="ValidatePackageReadmeExists"
           Condition="'$(PackageReadmeFilePath)' != '' and
                      !Exists('$(PackageReadmeFilePath)')">

diff --git a/src/libraries/Directory.Build.props b/src/libraries/Directory.Build.props
@@ -35,8 +35,6 @@
     <!-- We can't generate an apphost without restoring the targeting pack. -->
     <UseAppHost>false</UseAppHost>
     <EnableDefaultItems>false</EnableDefaultItems>
-    <!-- Libraries packages use the incremental servicing infrastructure. -->
-    <PackageUseIncrementalServicingVersion>true</PackageUseIncrementalServicingVersion>
   </PropertyGroup>
 
   <!-- Language configuration -->

diff --git a/src/libraries/Directory.Build.targets b/src/libraries/Directory.Build.targets
@@ -72,12 +72,11 @@
 
   <!-- The assembly version gets updated during servicing when the assembly isn't part of a targeting pack. -->
   <PropertyGroup Condition="'$(PreReleaseVersionLabel)' == 'servicing' and
-                            '$(IsPackable)' == 'true' and
-                            '$(PackageUseIncrementalServicingVersion)' == 'true'">
+                            '$(IsPackable)' == 'true'">
     <_IsWindowsDesktopApp Condition="$(WindowsDesktopCoreAppLibrary.Contains('$(AssemblyName);'))">true</_IsWindowsDesktopApp>
     <_IsAspNetCoreApp Condition="$(AspNetCoreAppLibrary.Contains('$(AssemblyName);'))">true</_IsAspNetCoreApp>
     <_AssemblyInTargetingPack Condition="('$(IsNETCoreAppSrc)' == 'true' or '$(IsNetCoreAppRef)' == 'true' or '$(_IsAspNetCoreApp)' == 'true' or '$(_IsWindowsDesktopApp)' == 'true') and '$(TargetFrameworkIdentifier)' != '.NETFramework'">true</_AssemblyInTargetingPack>
-    <AssemblyVersion Condition="'$(_AssemblyInTargetingPack)' != 'true'">$(MajorVersion).$(MinorVersion).0.$(ServicingVersion)</AssemblyVersion>
+    <AssemblyVersion Condition="'$(_AssemblyInTargetingPack)' != 'true'">$(MajorVersion).$(MinorVersion).0.$(PatchVersion)</AssemblyVersion>
   </PropertyGroup>
 
   <Import Project="$(RepositoryEngineeringDir)versioning.targets" />

diff --git a/...rosoft.Extensions.Logging.Console.Tests/Microsoft.Extensions.Logging.Console.Tests.csproj b/...rosoft.Extensions.Logging.Console.Tests/Microsoft.Extensions.Logging.Console.Tests.csproj
@@ -10,6 +10,6 @@
   <ItemGroup>
     <Compile Include="$(CoreLibSharedDir)System\Runtime\CompilerServices\IsExternalInit.cs" Link="Common\System\Runtime\CompilerServices\IsExternalInit.cs" />
     <ProjectReference Include="$(LibrariesProjectRoot)Microsoft.Extensions.Logging.Console\src\Microsoft.Extensions.Logging.Console.csproj" SkipUseReferenceAssembly="true" />
-    <ProjectReference Include="$(LibrariesProjectRoot)System.Diagnostics.DiagnosticSource\ref\System.Diagnostics.DiagnosticSource.csproj" />
+    <ProjectReference Include="$(LibrariesProjectRoot)System.Diagnostics.DiagnosticSource\src\System.Diagnostics.DiagnosticSource.csproj" />
   </ItemGroup>
 </Project>
diff --git a/src/libraries/System.Collections.Specialized/src/CompatibilitySuppressions.xml b/src/libraries/System.Collections.Specialized/src/CompatibilitySuppressions.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!-- https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids -->
 <Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <!-- Type exposed publicly in implementation only for serialization purposes. -->
   <Suppression>