From 6cf59ea2f793b7be0f7047609c495f0e4597b8b4 Mon Sep 17 00:00:00 2001 From: Boliang Zhang <122517415+LegendaryBlair@users.noreply.github.com> Date: Mon, 20 Jan 2025 16:57:34 +0800 Subject: [PATCH 1/4] Update override-windows-sdk-package-version.md Add a section to talk about when to add / remove this property when working with WindowsAppSDK --- .../sdk/5.0/override-windows-sdk-package-version.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md index 86b930d255155..41f015bb2c047 100644 --- a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md +++ b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md @@ -50,3 +50,9 @@ Remove any use of `FrameworkReference` in your .NET 5+ app's project file when t ## Affected APIs Windows APIs in .NET 5 and later versions that are provided by the [Windows SDK targeting package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref). + +## Working with Windows App SDK + +When working with the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK), you may need to explicitly add the `WindowsSdkPackageVersion` property if the required [Windows SDK package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref) version cannot be resolved by .NET SDK. This issue can arise due to different release mechanisms for the Windows App SDK and .NET SDK, where the .NET SDK is shipped through Visual Studio. See details in this [GitHub issue](https://github.com/microsoft/WindowsAppSDK/issues/4734). + +You might also consider removing the `WindowsSdkPackageVersion` property once the required Windows SDK package version has been resolved by .NET SDK, ensuring you have the latest Windows SDK package. This typically happens after Visual Studio releases a new version and you have upgraded to that version. From 76b77f733b0241fa2e0305990887fa63735b42df Mon Sep 17 00:00:00 2001 From: Boliang Zhang <122517415+LegendaryBlair@users.noreply.github.com> Date: Wed, 22 Jan 2025 13:12:49 +0800 Subject: [PATCH 2/4] Move section to recommend action. --- .../sdk/5.0/override-windows-sdk-package-version.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md index 41f015bb2c047..6c88ee96fea87 100644 --- a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md +++ b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md @@ -47,12 +47,10 @@ This change was introduced to simplify the package override behavior for targeti Remove any use of `FrameworkReference` in your .NET 5+ app's project file when targeting the Windows SDK. +When working with the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK), you may need to explicitly add the `WindowsSdkPackageVersion` property if the required [Windows SDK package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref) version cannot be resolved by .NET SDK. This issue can arise due to different release mechanisms for the Windows App SDK and .NET SDK, where the .NET SDK is shipped through Visual Studio. See details in this [GitHub issue](https://github.com/microsoft/WindowsAppSDK/issues/4734). You might also consider removing the `WindowsSdkPackageVersion` property once the required Windows SDK package version has been resolved by .NET SDK, ensuring you have the latest Windows SDK package. This typically happens after Visual Studio releases a new version and you have upgraded to that version. + ## Affected APIs Windows APIs in .NET 5 and later versions that are provided by the [Windows SDK targeting package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref). -## Working with Windows App SDK - -When working with the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK), you may need to explicitly add the `WindowsSdkPackageVersion` property if the required [Windows SDK package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref) version cannot be resolved by .NET SDK. This issue can arise due to different release mechanisms for the Windows App SDK and .NET SDK, where the .NET SDK is shipped through Visual Studio. See details in this [GitHub issue](https://github.com/microsoft/WindowsAppSDK/issues/4734). -You might also consider removing the `WindowsSdkPackageVersion` property once the required Windows SDK package version has been resolved by .NET SDK, ensuring you have the latest Windows SDK package. This typically happens after Visual Studio releases a new version and you have upgraded to that version. From 2fd1437d33ba0ac9f7db6a30488f2159dd372014 Mon Sep 17 00:00:00 2001 From: Boliang Zhang <122517415+LegendaryBlair@users.noreply.github.com> Date: Wed, 22 Jan 2025 13:15:23 +0800 Subject: [PATCH 3/4] Remove extra blank lines in markdown --- .../sdk/5.0/override-windows-sdk-package-version.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md index 6c88ee96fea87..2ee72f4f37f00 100644 --- a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md +++ b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md @@ -52,5 +52,3 @@ When working with the [Windows App SDK](https://github.com/microsoft/WindowsAppS ## Affected APIs Windows APIs in .NET 5 and later versions that are provided by the [Windows SDK targeting package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref). - - From 969813b730cf953d77f4777389b94eb7287ee739 Mon Sep 17 00:00:00 2001 From: Boliang Zhang <122517415+LegendaryBlair@users.noreply.github.com> Date: Thu, 23 Jan 2025 12:11:56 +0800 Subject: [PATCH 4/4] Update docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md accept the suggestion Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- .../sdk/5.0/override-windows-sdk-package-version.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md index 2ee72f4f37f00..ce502a9bfabd2 100644 --- a/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md +++ b/docs/core/compatibility/sdk/5.0/override-windows-sdk-package-version.md @@ -47,7 +47,7 @@ This change was introduced to simplify the package override behavior for targeti Remove any use of `FrameworkReference` in your .NET 5+ app's project file when targeting the Windows SDK. -When working with the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK), you may need to explicitly add the `WindowsSdkPackageVersion` property if the required [Windows SDK package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref) version cannot be resolved by .NET SDK. This issue can arise due to different release mechanisms for the Windows App SDK and .NET SDK, where the .NET SDK is shipped through Visual Studio. See details in this [GitHub issue](https://github.com/microsoft/WindowsAppSDK/issues/4734). You might also consider removing the `WindowsSdkPackageVersion` property once the required Windows SDK package version has been resolved by .NET SDK, ensuring you have the latest Windows SDK package. This typically happens after Visual Studio releases a new version and you have upgraded to that version. +When working with the [Windows App SDK](https://github.com/microsoft/WindowsAppSDK), you might need to explicitly add the `WindowsSdkPackageVersion` property if the required [Windows SDK package](https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref) version cannot be resolved by .NET SDK. This issue can arise due to different release mechanisms for the Windows App SDK and .NET SDK, where the .NET SDK is shipped through Visual Studio. See details in this [GitHub issue](https://github.com/microsoft/WindowsAppSDK/issues/4734). You might also consider removing the `WindowsSdkPackageVersion` property once the required Windows SDK package version has been resolved by .NET SDK, ensuring you have the latest Windows SDK package. This typically happens after Visual Studio releases a new version and you've upgraded to that version. ## Affected APIs