Skip to content

Commit 6c47cf8

Browse files
authored
Rename transport packages to follow convention (#57504)
* Rename transport packages to follow convention As agreed on in dotnet/windowsdesktop#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. * Update src.proj * Update src.proj
1 parent 1bb6894 commit 6c47cf8

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

docs/coding-guidelines/libraries-packaging.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Removing a library from the shared framework is a breaking change and should be
2222

2323
Transport packages are non-shipping packages that dotnet/runtime produces in order to share binaries with other repositories.
2424

25-
### Microsoft.AspNetCore.Internal.Transport
25+
### Microsoft.Internal.Runtime.**TARGET**.Transport
2626

27-
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.
27+
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.
2828

29-
To add a library to the ASP.NETCore shared framework, that library should be listed in the `AspNetCoreAppLibrary` section in `NetCoreAppLibrary.props`.
29+
To add a library to the target's shared framework, that library should be listed in the `AspNetCoreAppLibrary` or `WindowsDesktopAppLibrary` section in `NetCoreAppLibrary.props`.
3030

31-
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).
31+
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).
3232

33-
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
33+
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
3434

3535
Removing a library from this transport package is a breaking change and should be avoided.
3636

src/libraries/Microsoft.AspNetCore.Internal.Transport/src/Microsoft.AspNetCore.Internal.Transport.proj renamed to src/libraries/Microsoft.Internal.Runtime.AspNetCore.Transport/src/Microsoft.Internal.Runtime.AspNetCore.Transport.proj

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@
88
<IncludeBuildOutput>true</IncludeBuildOutput>
99
<DebugSymbols>false</DebugSymbols>
1010
<DebugType>none</DebugType>
11-
<!-- This is non-shipping package. -->
11+
<!-- Enable when the package shipped with NET6. -->
1212
<DisablePackageBaselineValidation>true</DisablePackageBaselineValidation>
13-
<PackageDescription>Internal transport package to provide aspnetcore with the assemblies that make up the Microsoft.ASPNetCore.App shared framework.</PackageDescription>
13+
<PackageDescription>Internal transport package to provide aspnetcore with the assemblies from dotnet/runtime that make up the Microsoft.AspNetCore.App shared framework.</PackageDescription>
1414
<!-- Reference elements are missing from the nuspec: https://github.com/NuGet/Home/issues/8684. -->
1515
<NoWarn>$(NoWarn);NU5131</NoWarn>
1616
</PropertyGroup>
1717

1818
<ItemGroup>
19-
<!-- Requires Private=true to calculate ReferenceCopyLocalPaths items. -->
20-
<ProjectReference Include="@(AspNetCoreAppLibrary->'$(LibrariesProjectRoot)%(Identity)\src\%(Identity).csproj')" PrivateAssets="all" Pack="true" Private="true" IncludeReferenceAssemblyInPackage="true" />
19+
<!-- Requires Private=true to calculate ReferenceCopyLocalPaths items. Also share System.Net.Quic which isn't part of aspnetcore's shared framework but which is needed by them. -->
20+
<ProjectReference Include="@(AspNetCoreAppLibrary->'$(LibrariesProjectRoot)%(Identity)\src\%(Identity).csproj');
21+
$(LibrariesProjectRoot)System.Net.Quic\src\System.Net.Quic.csproj" PrivateAssets="all" Pack="true" Private="true" IncludeReferenceAssemblyInPackage="true" />
2122
<!-- TODO: Find a better way to include source generators without hardcoding them. -->
2223
<AnalyzerReference Include="$(LibrariesProjectRoot)Microsoft.Extensions.Logging.Abstractions\gen\Microsoft.Extensions.Logging.Generators.csproj" />
2324
</ItemGroup>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
<IncludeBuildOutput>true</IncludeBuildOutput>
99
<DebugSymbols>false</DebugSymbols>
1010
<DebugType>none</DebugType>
11-
<!-- This is non-shipping package. -->
11+
<!-- Enable when the package shipped with NET6. -->
1212
<DisablePackageBaselineValidation>true</DisablePackageBaselineValidation>
13-
<PackageDescription>Internal transport package to provide windowsdesktop with the assemblies that make up the Microsoft.WindowsDesktop.App shared framework.</PackageDescription>
13+
<PackageDescription>Internal transport package to provide windowsdesktop with the assemblies from dotnet/runtime that make up the Microsoft.WindowsDesktop.App shared framework.</PackageDescription>
1414
<!-- Reference elements are missing from the nuspec: https://github.com/NuGet/Home/issues/8684. -->
1515
<NoWarn>$(NoWarn);NU5131</NoWarn>
1616
</PropertyGroup>

src/libraries/NetCoreAppLibrary.props

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,6 @@
181181
Microsoft.Extensions.Primitives;
182182
System.Diagnostics.EventLog;
183183
System.IO.Pipelines;
184-
System.Net.Quic;
185184
System.Security.Cryptography.Xml;
186185
</AspNetCoreAppLibrary>
187186
<WindowsDesktopCoreAppLibrary>

src/libraries/src.proj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
Exclude="@(ProjectExclusions);
1010
$(MSBuildThisFileDirectory)*\src\**\*.shproj" />
1111
<!-- Build these packages which reference many other projects in the allconfigurations leg only. -->
12-
<_allSrc Remove="Microsoft.AspNetCore.Internal.Transport\src\Microsoft.AspNetCore.Internal.Transport.proj;
13-
Microsoft.Windows.Compatibility\src\Microsoft.Windows.Compatibility.csproj;
14-
Microsoft.WindowsDesktop.Internal.Transport\src\Microsoft.WindowsDesktop.Internal.Transport.proj"
12+
<_allSrc Remove="Microsoft.Internal.Runtime.AspNetCore.Transport\src\Microsoft.Internal.Runtime.AspNetCore.Transport.proj;
13+
Microsoft.Internal.Runtime.WindowsDesktop.Transport\src\Microsoft.Internal.Runtime.WindowsDesktop.Transport.proj;
14+
Microsoft.Windows.Compatibility\src\Microsoft.Windows.Compatibility.csproj"
1515
Condition="'$(BuildAllConfigurations)' != 'true'" />
1616

1717
<NonNetCoreAppProject Include="@(_allSrc)"

0 commit comments

Comments
 (0)