Skip to content

Commit fb993f5

Browse files
authored
[release/7.0] Improve servicing docs for Microsoft.Windows.Compatibility (#83557)
* Add comment in csprojs of dependencies of M.W.Compat. * Adjust readme. * Turn off M.W.C. (reset it), it was built last month. --------- Co-authored-by: carlossanlop <[email protected]>
1 parent 74d0f47 commit fb993f5

File tree

30 files changed

+81
-7
lines changed

30 files changed

+81
-7
lines changed

docs/project/library-servicing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Servicing branches represent shipped versions of .NET, and their name is in the
1111

1212
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.
1313

14+
Additionally, if the library is listed among the project references of [Microsoft.Windows.Compatibility.csproj](https://github.com/dotnet/runtime/blob/43bb5993d4f983e9d575f52b691ecdc9b9e257ef/src/libraries/Microsoft.Windows.Compatibility/src/Microsoft.Windows.Compatibility.csproj#L15-L48), please make sure to bump the value of `ServicingVersion` for `Microsoft.Windows.Compatibility.csproj` and also set its `GeneratePackageOnBuild` property value to `true`. The version number must only be bumped once per servicing release, even if multiple dependencies get modified.
15+
1416
## Determine ServiceVersion
1517

1618
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.

src/libraries/Microsoft.Win32.Registry.AccessControl/src/Microsoft.Win32.Registry.AccessControl.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
<TargetFrameworks>$(NetCoreAppCurrent)-windows;$(NetCoreAppCurrent);$(NetCoreAppMinimum)-windows;$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum)</TargetFrameworks>
44
<IsPartialFacadeAssembly>true</IsPartialFacadeAssembly>
55
<IsPackable>true</IsPackable>
6+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
7+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
8+
<ServicingVersion>0</ServicingVersion>
69
<PackageDescription>Provides support for managing access and audit control lists for Microsoft.Win32.RegistryKey.
710

811
Commonly Used Types:

src/libraries/Microsoft.Win32.SystemEvents/src/Microsoft.Win32.SystemEvents.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
<TargetFrameworks>$(NetCoreAppCurrent)-windows;$(NetCoreAppCurrent);$(NetCoreAppMinimum)-windows;$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum)</TargetFrameworks>
44
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
55
<IsPackable>true</IsPackable>
6+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
7+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
8+
<ServicingVersion>0</ServicingVersion>
69
<PackageDescription>Provides access to Windows system event notifications.
710

811
Commonly Used Types:

src/libraries/Microsoft.Windows.Compatibility/src/Microsoft.Windows.Compatibility.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<!-- Reference the outputs for the dependency nodes calculation. -->
66
<NoTargetsDoNotReferenceOutputAssemblies>false</NoTargetsDoNotReferenceOutputAssemblies>
77
<IsPackable>true</IsPackable>
8-
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
8+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
99
<ServicingVersion>1</ServicingVersion>
1010
<!-- This is a meta package and doesn't contain any libs. -->
1111
<NoWarn>$(NoWarn);NU5128</NoWarn>
@@ -47,7 +47,7 @@
4747
</ItemGroup>
4848

4949
<ItemGroup>
50-
<PackageReference Include="System.Data.SqlClient" Version="$(SystemDataSqlClientVersion)" />
50+
<PackageReference Include="System.Data.SqlClient" Version="$(SystemDataSqlClientVersion)" />
5151
<PackageReference Include="System.ServiceModel.Primitives;
5252
System.ServiceModel.Duplex;
5353
System.ServiceModel.Http;

src/libraries/System.CodeDom/src/System.CodeDom.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
<Nullable>annotations</Nullable>
77
<IsTrimmable>false</IsTrimmable>
88
<IsPackable>true</IsPackable>
9+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
10+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
11+
<ServicingVersion>0</ServicingVersion>
912
<PackageDescription>Provides types that can be used to model the structure of a source code document and to output source code for that model in a supported language.
1013

1114
Commonly Used Types:

src/libraries/System.ComponentModel.Composition.Registration/src/System.ComponentModel.Composition.Registration.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
<NoWarn>$(NoWarn);nullable</NoWarn>
66
<IsTrimmable>false</IsTrimmable>
77
<IsPackable>true</IsPackable>
8+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
9+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
10+
<ServicingVersion>0</ServicingVersion>
811
<AddNETFrameworkPlaceholderFileToPackage>true</AddNETFrameworkPlaceholderFileToPackage>
912
<AddNETFrameworkAssemblyReferenceToPackage>true</AddNETFrameworkAssemblyReferenceToPackage>
1013
<PackageDescription>This namespace provides classes that constitute the core of the Managed Extensibility Framework, or MEF.

src/libraries/System.ComponentModel.Composition/src/System.ComponentModel.Composition.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppMinimum);netstandard2.0</TargetFrameworks>
44
<IsTrimmable>false</IsTrimmable>
55
<IsPackable>true</IsPackable>
6+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
7+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
8+
<ServicingVersion>0</ServicingVersion>
69
<AddNETFrameworkPlaceholderFileToPackage>true</AddNETFrameworkPlaceholderFileToPackage>
710
<AddNETFrameworkAssemblyReferenceToPackage>true</AddNETFrameworkAssemblyReferenceToPackage>
811
<PackageDescription>This namespace provides classes that constitute the core of the Managed Extensibility Framework, or MEF.

src/libraries/System.Configuration.ConfigurationManager/src/System.Configuration.ConfigurationManager.csproj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
<IsTrimmable>false</IsTrimmable>
88
<NoWarn>$(NoWarn);CA1847</NoWarn>
99
<IsPackable>true</IsPackable>
10+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
11+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
12+
<ServicingVersion>0</ServicingVersion>
1013
<PackageDescription>Provides types that support using configuration files.
1114

1215
Commonly Used Types:
@@ -262,7 +265,7 @@ System.Configuration.ConfigurationManager</PackageDescription>
262265
<Compile Include="$(CommonPath)System\Obsoletions.cs" Link="Common\System\Obsoletions.cs" />
263266
<Compile Include="$(CoreLibSharedDir)System\Diagnostics\CodeAnalysis\UnconditionalSuppressMessageAttribute.cs" Condition="'$(TargetFrameworkIdentifier)' != '.NETCoreApp'" />
264267
</ItemGroup>
265-
268+
266269
<ItemGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net7.0'))">
267270
<Compile Include="System\Diagnostics\DiagnosticsConfiguration.cs" />
268271
<Compile Include="System\Diagnostics\FilterElement.cs" />

src/libraries/System.Data.Odbc/src/System.Data.Odbc.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
<!-- Suppress CA1845: Use span-based 'string.Concat' and 'AsSpan' instead of 'Substring' to avoid ifdefs. -->
77
<NoWarn>$(NoWarn);CA1845</NoWarn>
88
<IsPackable>true</IsPackable>
9+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
10+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
11+
<ServicingVersion>0</ServicingVersion>
912
<PackageDescription>Provides a collection of classes used to access an ODBC data source in the managed space
1013

1114
Commonly Used Types:

src/libraries/System.Data.OleDb/src/System.Data.OleDb.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
<!-- Suppress CA1845: Use span-based 'string.Concat' and 'AsSpan' instead of 'Substring' to avoid ifdefs. -->
1010
<NoWarn>$(NoWarn);CA1845</NoWarn>
1111
<IsPackable>true</IsPackable>
12+
<!-- If you enable GeneratePackageOnBuild for this package and bump ServicingVersion, make sure to also bump ServicingVersion in Microsoft.Windows.Compatibility.csproj once for the next release. -->
13+
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
14+
<ServicingVersion>0</ServicingVersion>
1215
<PackageDescription>Provides a collection of classes for OLEDB.
1316

1417
Commonly Used Types:

0 commit comments

Comments
 (0)