Skip to content

Commit

Permalink
modify frameworkreference guidance (microsoft#944)
Browse files Browse the repository at this point in the history
  • Loading branch information
angelazhangmsft authored Jul 30, 2021
1 parent 8e04090 commit 990ac98
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,16 @@ For CsWinRT NuGet prereleases between any .NET servicing or feature releases, *\

2. **[Diamond Dependency]**: An application is built using multiple components, for example WinUI and a library named *SimpleMath*. The WinUI library is built with .NET 5.0.100 while the *SimpleMath* library is built with .NET 5.0.200. In this scenario, there is an `AssemblyVersion` update in .NET 5.0.200. The application developer must upgrade to the latest version of the .NET SDK for any of its dependencies, in this case .NET 5.0.200. The warnings and errors encountered are manifested in the same manner as in Scenario #1.

3. **[Framework Reference Preview Override]**: An application developer runs into a blocking bug with the Windows SDK projections in the latest CsWinRT release. To address this issue, Microsoft releases a preview Windows SDK projection package that the developer can use by adding an override in their project file, for example as follows. This would be a temporary workaround for the developer that should be removed when there is a .NET SDK update.

3. **[Windows SDK package override]**: An application developer runs into a blocking bug with the Windows SDK projections in the latest CsWinRT release. To address this issue, Microsoft releases a preview Windows SDK projection package that the developer can use by adding an override in their project file. This would be a temporary workaround for the developer that should be removed when there is a .NET SDK update.

Starting in .NET SDK 5.0.302 and .NET SDK 5.0.205 or later, developers can use `WindowsSdkPackageVersion` to override their Windows SDK package version, as shown below. `FrameworkReference` is no longer supported in these versions of the .NET SDK.
```xml
<PropertyGroup>
<WindowsSdkPackageVersion>10.0.19041.18</WindowsSdkPackageVersion>
</PropertyGroup>
```

For earlier versions of the .NET SDK, developers can override the Windows SDK package with a `FrameworkReference` override:
```xml
<ItemGroup>
<FrameworkReference Update="Microsoft.Windows.SDK.NET.Ref" RuntimeFrameworkVersion="10.0.18362.11-preview" />
Expand Down

0 comments on commit 990ac98

Please sign in to comment.