From de13f46df6fcbc8727a818dab66e23a30e289d2c Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Mon, 16 Aug 2021 18:35:25 +0200 Subject: [PATCH 1/3] Rename transport packages to follow convention As agreed on in https://github.com/dotnet/windowsdesktop/pull/1936, we want to follow a common schema when naming our transport packages. Also updating the docs to reflect the name changes and to also accomodate for the WindowsDesktop transport package. --- docs/coding-guidelines/libraries-packaging.md | 10 +++++----- ...crosoft.Internal.Runtime.AspNetCore.Transport.proj} | 9 +++++---- ...oft.Internal.Runtime.WindowsDesktop.Transport.proj} | 4 ++-- src/libraries/NetCoreAppLibrary.props | 1 - 4 files changed, 12 insertions(+), 12 deletions(-) rename src/libraries/{Microsoft.AspNetCore.Internal.Transport/src/Microsoft.AspNetCore.Internal.Transport.proj => Microsoft.Internal.Runtime.AspNetCore.Transport/src/Microsoft.Internal.Runtime.AspNetCore.Transport.proj} (68%) rename src/libraries/{Microsoft.WindowsDesktop.Internal.Transport/src/Microsoft.WindowsDesktop.Internal.Transport.proj => Microsoft.Internal.Runtime.WindowsDesktop.Transport/src/Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj} (85%) diff --git a/docs/coding-guidelines/libraries-packaging.md b/docs/coding-guidelines/libraries-packaging.md index a2b62ae16267e7..8e2b4db7e84e66 100644 --- a/docs/coding-guidelines/libraries-packaging.md +++ b/docs/coding-guidelines/libraries-packaging.md @@ -22,15 +22,15 @@ Removing a library from the shared framework is a breaking change and should be Transport packages are non-shipping packages that dotnet/runtime produces in order to share binaries with other repositories. -### Microsoft.AspNetCore.Internal.Transport +### Microsoft.Internal.Runtime.**TARGET**.Transport -This package represents the set of libraries which are produced in dotnet/runtime and ship in the ASP.NETCore shared framework. We produce a transport package so that we can easily share reference assemblies and implementation configurations that might not be present in NuGet packages that also ship. +Such transport packages represent the set of libraries which are produced in dotnet/runtime and ship in target repo's shared framework (i.e. Microsoft.AspNetCore.App and Microsoft.WindowsDesktop.App). We produce a transport package so that we can easily share reference, implementation and analyzer assemblies that might not be present in NuGet packages that also ship. -To add a library to the ASP.NETCore shared framework, that library should be listed in the `AspNetCoreAppLibrary` section in `NetCoreAppLibrary.props`. +To add a library to the target's shared framework, that library should be listed in the `AspNetCoreAppLibrary` or `WindowsDesktopAppLibrary` section in `NetCoreAppLibrary.props`. -Source generators and analyzers can be included in the ASP.NETCore shared framework by adding them to the `Microsoft.AspNetCore.Internal.Transport.proj` as an AnalyzerReference. These projects should specify `AnalyzerLanguage` as mentioned [below](#analyzers--source-generators). +Source generators and analyzers can be included in the package by adding them to the `Microsoft.Internal.Runtime.**TARGET**.Transport.proj` as an AnalyzerReference. The analyzer projects should specify `AnalyzerLanguage` as mentioned [below](#analyzers--source-generators). -Libraries included in this transport package should ensure all direct and transitive assembly references are also included in either the ASP.NETCore shared framework or the .NETCore shared framework. This is not validated in dotnet/runtime at the moment: https://github.com/dotnet/runtime/issues/52562 +Libraries included in this transport package should ensure all direct and transitive assembly references are also included in either the target's shared framework or the Microsoft.NETCore.App shared framework. This is not validated in dotnet/runtime at the moment: https://github.com/dotnet/runtime/issues/52562 Removing a library from this transport package is a breaking change and should be avoided. diff --git a/src/libraries/Microsoft.AspNetCore.Internal.Transport/src/Microsoft.AspNetCore.Internal.Transport.proj b/src/libraries/Microsoft.Internal.Runtime.AspNetCore.Transport/src/Microsoft.Internal.Runtime.AspNetCore.Transport.proj similarity index 68% rename from src/libraries/Microsoft.AspNetCore.Internal.Transport/src/Microsoft.AspNetCore.Internal.Transport.proj rename to src/libraries/Microsoft.Internal.Runtime.AspNetCore.Transport/src/Microsoft.Internal.Runtime.AspNetCore.Transport.proj index f67709f091edf6..ab3ec6f159302c 100644 --- a/src/libraries/Microsoft.AspNetCore.Internal.Transport/src/Microsoft.AspNetCore.Internal.Transport.proj +++ b/src/libraries/Microsoft.Internal.Runtime.AspNetCore.Transport/src/Microsoft.Internal.Runtime.AspNetCore.Transport.proj @@ -8,16 +8,17 @@ true false none - + true - Internal transport package to provide aspnetcore with the assemblies that make up the Microsoft.ASPNetCore.App shared framework. + Internal transport package to provide aspnetcore with the assemblies from dotnet/runtime that make up the Microsoft.AspNetCore.App shared framework. $(NoWarn);NU5131 - - + + diff --git a/src/libraries/Microsoft.WindowsDesktop.Internal.Transport/src/Microsoft.WindowsDesktop.Internal.Transport.proj b/src/libraries/Microsoft.Internal.Runtime.WindowsDesktop.Transport/src/Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj similarity index 85% rename from src/libraries/Microsoft.WindowsDesktop.Internal.Transport/src/Microsoft.WindowsDesktop.Internal.Transport.proj rename to src/libraries/Microsoft.Internal.Runtime.WindowsDesktop.Transport/src/Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj index 3f6e1994407ab7..fa9dc31e8edfa7 100644 --- a/src/libraries/Microsoft.WindowsDesktop.Internal.Transport/src/Microsoft.WindowsDesktop.Internal.Transport.proj +++ b/src/libraries/Microsoft.Internal.Runtime.WindowsDesktop.Transport/src/Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj @@ -8,9 +8,9 @@ true false none - + true - Internal transport package to provide windowsdesktop with the assemblies that make up the Microsoft.WindowsDesktop.App shared framework. + Internal transport package to provide windowsdesktop with the assemblies from dotnet/runtime that make up the Microsoft.WindowsDesktop.App shared framework. $(NoWarn);NU5131 diff --git a/src/libraries/NetCoreAppLibrary.props b/src/libraries/NetCoreAppLibrary.props index dbb95772605dd6..f9221a8f5547f5 100644 --- a/src/libraries/NetCoreAppLibrary.props +++ b/src/libraries/NetCoreAppLibrary.props @@ -181,7 +181,6 @@ Microsoft.Extensions.Primitives; System.Diagnostics.EventLog; System.IO.Pipelines; - System.Net.Quic; System.Security.Cryptography.Xml; From 79d355c70d57fae72b08403988bb014348e12027 Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Mon, 16 Aug 2021 19:30:20 +0200 Subject: [PATCH 2/3] Update src.proj --- src/libraries/src.proj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/libraries/src.proj b/src/libraries/src.proj index e2cda400cde09b..d7edc165a618c3 100644 --- a/src/libraries/src.proj +++ b/src/libraries/src.proj @@ -10,8 +10,8 @@ $(MSBuildThisFileDirectory)*\src\**\*.shproj" /> <_allSrc Remove="Microsoft.AspNetCore.Internal.Transport\src\Microsoft.AspNetCore.Internal.Transport.proj; - Microsoft.Windows.Compatibility\src\Microsoft.Windows.Compatibility.csproj; - Microsoft.WindowsDesktop.Internal.Transport\src\Microsoft.WindowsDesktop.Internal.Transport.proj" + Microsoft.Internal.Runtime.AspNetCore.Transport\src\Microsoft.Internal.Runtime.AspNetCore.Transport.proj; + Microsoft.Internal.Runtime.WindowsDesktop.Transport\src\Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj" Condition="'$(BuildAllConfigurations)' != 'true'" /> Date: Mon, 16 Aug 2021 20:23:37 +0200 Subject: [PATCH 3/3] Update src.proj --- src/libraries/src.proj | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/libraries/src.proj b/src/libraries/src.proj index d7edc165a618c3..8b38ce5b449390 100644 --- a/src/libraries/src.proj +++ b/src/libraries/src.proj @@ -9,9 +9,9 @@ Exclude="@(ProjectExclusions); $(MSBuildThisFileDirectory)*\src\**\*.shproj" /> - <_allSrc Remove="Microsoft.AspNetCore.Internal.Transport\src\Microsoft.AspNetCore.Internal.Transport.proj; - Microsoft.Internal.Runtime.AspNetCore.Transport\src\Microsoft.Internal.Runtime.AspNetCore.Transport.proj; - Microsoft.Internal.Runtime.WindowsDesktop.Transport\src\Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj" + <_allSrc Remove="Microsoft.Internal.Runtime.AspNetCore.Transport\src\Microsoft.Internal.Runtime.AspNetCore.Transport.proj; + Microsoft.Internal.Runtime.WindowsDesktop.Transport\src\Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj; + Microsoft.Windows.Compatibility\src\Microsoft.Windows.Compatibility.csproj" Condition="'$(BuildAllConfigurations)' != 'true'" />