336 lines
19 KiB
XML
336 lines
19 KiB
XML
<!--
|
|
The targets in this file are used to implement custom <Reference> resolution.
|
|
For more details, see /docs/ReferenceResolution.md.
|
|
|
|
Properties which can be set by projects. If unset, these will be inferred.
|
|
|
|
* UseLatestPackageReferences = resolve `<Reference>` items to the latest version of PackageReferences in eng/Dependencies.props.
|
|
* UseProjectReferences = prefer project references to packages
|
|
* IsProjectReferenceProvider = when true, the assembly in this project should be available as a ProjectReferenceProvider (see below).
|
|
|
|
Items used by the resolution strategy:
|
|
|
|
* BaselinePackageReference = a list of packages that were reference in the last release of the project currently building
|
|
* LatestPackageReference = a list of the latest versions of packages
|
|
* Reference = a list of the references which are needed for compilation or runtime
|
|
* ProjectReferenceProvider = a list which maps of assembly names to the project file that produces it
|
|
-->
|
|
<Project>
|
|
|
|
<PropertyGroup>
|
|
<EnableCustomReferenceResolution
|
|
Condition="'$(EnableCustomReferenceResolution)' == '' AND ('$(DotNetBuildFromSource)' != 'true' OR '$(ExcludeFromSourceBuild)' != 'true')">true</EnableCustomReferenceResolution>
|
|
|
|
<ResolveReferencesDependsOn>
|
|
ResolveCustomReferences;
|
|
$(ResolveReferencesDependsOn);
|
|
</ResolveReferencesDependsOn>
|
|
</PropertyGroup>
|
|
|
|
<PropertyGroup>
|
|
<!--
|
|
Projects should only use the latest package references when:
|
|
* preparing a new major or minor release (i.e. a non-servicing builds)
|
|
* when a project is a test or sample project
|
|
* when a package is releasing a new patch (we like to update external dependencies in patches when possible)
|
|
-->
|
|
<UseLatestPackageReferences
|
|
Condition=" '$(UseLatestPackageReferences)' == '' AND '$(IsServicingBuild)' != 'true' ">true</UseLatestPackageReferences>
|
|
<UseLatestPackageReferences
|
|
Condition=" '$(UseLatestPackageReferences)' == '' AND '$(IsImplementationProject)' != 'true' ">true</UseLatestPackageReferences>
|
|
<UseLatestPackageReferences
|
|
Condition=" '$(UseLatestPackageReferences)' == '' AND '$(IsImplementationProject)' == 'true' AND '$(IsPackable)' == 'true' ">true</UseLatestPackageReferences>
|
|
<UseLatestPackageReferences
|
|
Condition=" '$(UseLatestPackageReferences)' == '' ">false</UseLatestPackageReferences>
|
|
|
|
<!--
|
|
Projects should only use the project references instead of baseline package references when:
|
|
* preparing a new major or minor release (i.e. a non-servicing builds)
|
|
* when a project is a test or sample project
|
|
We don't use project references between components in servicing builds between components to preserve the baseline as much as possible.
|
|
-->
|
|
<UseProjectReferences
|
|
Condition=" '$(UseProjectReferences)' == '' AND '$(IsServicingBuild)' != 'true' ">true</UseProjectReferences>
|
|
<UseProjectReferences
|
|
Condition=" '$(UseProjectReferences)' == '' AND '$(IsImplementationProject)' != 'true' ">true</UseProjectReferences>
|
|
<UseProjectReferences Condition=" '$(UseProjectReferences)' == '' ">false</UseProjectReferences>
|
|
</PropertyGroup>
|
|
|
|
<ItemDefinitionGroup>
|
|
<Reference>
|
|
<IsSharedSource></IsSharedSource>
|
|
</Reference>
|
|
</ItemDefinitionGroup>
|
|
|
|
<ItemGroup Condition="'$(EnableCustomReferenceResolution)' == 'true'">
|
|
<Reference Update="@(Reference)">
|
|
<IsSharedSource
|
|
Condition="'%(IsSharedSource)' == '' AND $([System.String]::new('%(Identity)').EndsWith('.Sources'))">true</IsSharedSource>
|
|
</Reference>
|
|
|
|
<!-- Packages which are implicitly defined by the .NET Core SDK. -->
|
|
<_ImplicitPackageReference Include="@(PackageReference->WithMetadataValue('IsImplicitlyDefined', 'true'))" />
|
|
<!-- Capture a list of references which were set explicitly in the project. -->
|
|
<_AllowedExplicitPackageReference Include="@(PackageReference->WithMetadataValue('AllowExplicitReference', 'true'))" />
|
|
<_AllowedExplicitPackageReference Include="FSharp.Core" Condition="'$(MSBuildProjectExtension)' == '.fsproj'" />
|
|
<_ExplicitPackageReference Include="@(PackageReference)" Exclude="@(_ImplicitPackageReference);@(_AllowedExplicitPackageReference)" />
|
|
|
|
<_CompilationOnlyReference Condition="'$(TargetFramework)' == 'netstandard2.0'"
|
|
Include="@(Reference->WithMetadataValue('NuGetPackageId','NETStandard.Library'))" />
|
|
|
|
<_InvalidReferenceToNonSharedFxAssembly Condition="'$(IsAspNetCoreApp)' == 'true'"
|
|
Include="@(Reference)"
|
|
Exclude="
|
|
@(AspNetCoreAppReference);
|
|
@(AspNetCoreAppReferenceAndPackage);
|
|
@(ExternalAspNetCoreAppReference);
|
|
@(_CompilationOnlyReference);
|
|
@(Reference->WithMetadataValue('IsSharedSource', 'true'));
|
|
@(Reference->WithMetadataValue('PrivateAssets', 'All'))" />
|
|
<_OriginalReferences Include="@(Reference)" />
|
|
</ItemGroup>
|
|
|
|
<!--
|
|
Turn Reference items into a ProjectReference when UseProjectReferences is true. Order matters; this
|
|
comes before package resolution because projects should be used when possible instead of packages.
|
|
-->
|
|
<ItemGroup Condition=" '$(EnableCustomReferenceResolution)' == 'true' AND '$(UseProjectReferences)' == 'true' ">
|
|
<!-- Copy then Update / Copy to intersect the ProjectReferenceProvider and Reference item groups. -->
|
|
<_AllProjectReference Include="@(ProjectReferenceProvider)" />
|
|
|
|
<!-- Use only Reference items when project is a reference provider. Simplifies project moves and shortens files. -->
|
|
<_AllProjectReference Update="@(ProjectReference->'%(Filename)')" DirectUse="1" />
|
|
|
|
<_AllProjectReference Update="@(Reference)" Use="1">
|
|
<!--
|
|
Metadata list is long because (a) Update defaults to copying no metadata and (b) ProjectReference metadata
|
|
may include (real) Reference metadata and MSBuild task parameters. Even so, the list below is not exhaustive.
|
|
-->
|
|
<Aliases>%(Reference.Aliases)</Aliases>
|
|
<BuildInParallel>%(Reference.BuildInParallel)</BuildInParallel>
|
|
<DoNotHarvest>%(Reference.DoNotHarvest)</DoNotHarvest>
|
|
<ExcludeAssets>%(Reference.ExcludeAssets)</ExcludeAssets>
|
|
<IncludeAssets>%(Reference.IncludeAssets)</IncludeAssets>
|
|
<IsNativeImage>%(Reference.IsNativeImage)</IsNativeImage>
|
|
<LinkBase>%(Reference.LinkBase)</LinkBase>
|
|
<Name>%(Reference.Name)</Name>
|
|
<OutputItemType>%(Reference.OutputItemType)</OutputItemType>
|
|
<Package>%(Reference.Package)</Package>
|
|
<Private>%(Reference.Private)</Private>
|
|
<PrivateAssets>%(Reference.PrivateAssets)</PrivateAssets>
|
|
<Project>%(Reference.Project)</Project>
|
|
<Properties>%(Reference.Properties)</Properties>
|
|
<Publish>%(Reference.Publish)</Publish>
|
|
<ReferenceOutputAssembly>%(Reference.ReferenceOutputAssembly)</ReferenceOutputAssembly>
|
|
<SetPlatform>%(Reference.SetPlatform)</SetPlatform>
|
|
<SkipGetTargetFrameworkProperties>%(Reference.SkipGetTargetFrameworkProperties)</SkipGetTargetFrameworkProperties>
|
|
<Targets>%(Reference.Targets)</Targets>
|
|
<UndefineProperties>%(Reference.UndefineProperties)</UndefineProperties>
|
|
<Watch>%(Reference.Watch)</Watch>
|
|
</_AllProjectReference>
|
|
|
|
<ProjectReference Include="@(_AllProjectReference->WithMetadataValue('Use', '1')->'%(ProjectPath)')" Use="" />
|
|
<Reference Remove="@(_AllProjectReference->WithMetadataValue('Use', '1'))" />
|
|
</ItemGroup>
|
|
|
|
<!--
|
|
This target helps ensure projects within the shared framework do no unintentionally add new references, and that
|
|
assemblies outside the shared framework reference the framework as a whole instead of using individual assemblies.
|
|
In addition, enforce use of Reference items for projects reference providers.
|
|
-->
|
|
<Target Name="_CheckForReferenceBoundaries" BeforeTargets="CollectPackageReferences;ResolveReferences">
|
|
<Error
|
|
Condition="@(_InvalidReferenceToSharedFxOnlyAssembly->Count()) != 0"
|
|
Text="Cannot reference "%(_InvalidReferenceToSharedFxOnlyAssembly.Identity)" directly because it is part of the shared framework and this project is not. Use <FrameworkReference Include="Microsoft.AspNetCore.App" /> instead." />
|
|
|
|
<Error
|
|
Condition="@(_InvalidReferenceToNonSharedFxAssembly->Count()) != 0 AND '$(TargetFramework)' == '$(DefaultNetCoreTargetFramework)'"
|
|
Text="Cannot reference "%(_InvalidReferenceToNonSharedFxAssembly.Identity)". This dependency is not in the shared framework. See docs/SharedFramework.md for instructions on how to modify what is in the shared framework." />
|
|
|
|
<Error
|
|
Condition=" '$(EnableCustomReferenceResolution)' == 'true' AND @(_AllProjectReference->WithMetadataValue('DirectUse', '1')->Count()) != 0 "
|
|
Text="Cannot reference "%(_AllProjectReference.Identity)" with a ProjectReference item; use a Reference item." />
|
|
</Target>
|
|
|
|
<Target Name="_WarnAboutRedundantRef" AfterTargets="ResolveFrameworkReferences;ProcessFrameworkReferences">
|
|
<Warning
|
|
Condition="@(FrameworkReference->WithMetadataValue('Identity', 'Microsoft.AspNetCore.App')->Count()) > 1"
|
|
Text="Redundant <FrameworkReference>. If you have an explicit item in the project file, you might be able to remove it. Some SDKs, like Microsoft.NET.Sdk.Web, add this implicitly." />
|
|
</Target>
|
|
|
|
<!--
|
|
This target resolves remaining Reference items to Packages, if possible. If not, they are left as Reference
|
|
items for the SDK to resolve. This executes on NuGet restore and during DesignTimeBuild. It should not run in
|
|
outer, cross-targeting build.
|
|
-->
|
|
<Target Name="ResolveCustomReferences"
|
|
BeforeTargets="CheckForImplicitPackageReferenceOverrides;CollectPackageReferences;ResolvePackageAssets"
|
|
Condition=" '$(TargetFramework)' != '' AND '$(EnableCustomReferenceResolution)' == 'true' ">
|
|
<ItemGroup>
|
|
<!-- Ensure only content assets are consumed from .Sources packages. -->
|
|
<Reference>
|
|
<IncludeAssets Condition="'%(IsSharedSource)' == 'true'">ContentFiles;Build</IncludeAssets>
|
|
<PrivateAssets Condition="'%(IsSharedSource)' == 'true'">All</PrivateAssets>
|
|
</Reference>
|
|
|
|
<!-- Identify if any references were present in the last release of this package, but have been removed. -->
|
|
<UnusedBaselinePackageReference Include="@(BaselinePackageReference)"
|
|
Exclude="@(Reference);@(PackageReference);@(ProjectReference->'%(Filename)')" />
|
|
|
|
<!-- Handle suppressions needed because above Exclude is not aware of references added in .nuspec files. -->
|
|
<UnusedBaselinePackageReference Remove="@(SuppressBaselineReference->WithMetadataValue('InNuspecFile', 'true'))"
|
|
Condition=" '$(IsServicingBuild)' == 'true' " />
|
|
|
|
<!-- Allow suppressions of any baseline changes in non-servicing builds. -->
|
|
<UnusedBaselinePackageReference Remove="@(SuppressBaselineReference)"
|
|
Condition=" '$(IsServicingBuild)' != 'true' " />
|
|
</ItemGroup>
|
|
|
|
<JoinItems Left="@(Reference)" Right="@(LatestPackageReference)" LeftMetadata="*" RightMetadata="Version"
|
|
Condition=" '$(UseLatestPackageReferences)' == 'true' ">
|
|
<Output TaskParameter="JoinResult" ItemName="_LatestPackageReferenceWithVersion" />
|
|
</JoinItems>
|
|
|
|
<ItemGroup>
|
|
<PackageReference Include="@(_LatestPackageReferenceWithVersion)" IsImplicitlyDefined="true" />
|
|
<!-- Remove reference items that have been resolved to a LatestPackageReference item. -->
|
|
<Reference Remove="@(_LatestPackageReferenceWithVersion)" />
|
|
</ItemGroup>
|
|
|
|
<!-- Resolve references from BaselinePackageReference for servicing builds in corner cases. May be unused. -->
|
|
<JoinItems Left="@(Reference)" Right="@(BaselinePackageReference)" LeftMetadata="*" RightMetadata="Version"
|
|
Condition=" '$(IsServicingBuild)' == 'true' OR '$(UseLatestPackageReferences)' != 'true' ">
|
|
<Output TaskParameter="JoinResult" ItemName="_BaselinePackageReferenceWithVersion" />
|
|
</JoinItems>
|
|
|
|
<ItemGroup>
|
|
<PackageReference Include="@(_BaselinePackageReferenceWithVersion)" IsImplicitlyDefined="true" />
|
|
<!-- Remove reference items that have been resolved to a BaselinePackageReference item. -->
|
|
<Reference Remove="@(_BaselinePackageReferenceWithVersion)" />
|
|
</ItemGroup>
|
|
|
|
<!-- For PrivateAssets=All references, like .Sources packages, fallback to LatestPackageReferences. -->
|
|
<JoinItems Left="@(Reference->WithMetadataValue('PrivateAssets', 'All'))"
|
|
Right="@(LatestPackageReference)"
|
|
LeftMetadata="*"
|
|
RightMetadata="Version">
|
|
<Output TaskParameter="JoinResult" ItemName="_PrivatePackageReferenceWithVersion" />
|
|
</JoinItems>
|
|
|
|
<ItemGroup>
|
|
<PackageReference Include="@(_PrivatePackageReferenceWithVersion)" IsImplicitlyDefined="true" />
|
|
<!-- Remove reference items that have been resolved to a LatestPackageReference item. -->
|
|
<Reference Remove="@(_PrivatePackageReferenceWithVersion)" />
|
|
|
|
<!-- Free up memory for unnecessary items -->
|
|
<_LatestPackageReferenceWithVersion Remove="@(_LatestPackageReferenceWithVersion)" />
|
|
<_BaselinePackageReferenceWithVersion Remove="@(_BaselinePackageReferenceWithVersion)" />
|
|
<_PrivatePackageReferenceWithVersion Remove="@(_PrivatePackageReferenceWithVersion)" />
|
|
<_ImplicitPackageReference Remove="@(_ImplicitPackageReference)" />
|
|
</ItemGroup>
|
|
|
|
<Error
|
|
Condition="'$(DisablePackageReferenceRestrictions)' != 'true' AND @(_ExplicitPackageReference->Count()) != 0"
|
|
Text="PackageReference items are not allowed. Use <Reference> instead to replace the reference to @(_ExplicitPackageReference, ', '). See docs/ReferenceResolution.md for more details." />
|
|
|
|
<ItemGroup>
|
|
<_ExplicitPackageReference Remove="@(_ExplicitPackageReference)" />
|
|
</ItemGroup>
|
|
|
|
<Warning
|
|
Condition=" '$(IsServicingBuild)' != 'true' AND '%(UnusedBaselinePackageReference.Identity)' != '' "
|
|
Code="BUILD001"
|
|
Text="Reference to '%(UnusedBaselinePackageReference.Identity)' was removed since the last stable release of this package. This could be a breaking change. See docs/ReferenceResolution.md for instructions on how to update changes to references or suppress this warning if the error was intentional." />
|
|
|
|
<Error
|
|
Condition=" '$(IsServicingBuild)' == 'true' AND @(UnusedBaselinePackageReference->Count()) != 0 "
|
|
Code="BUILD002"
|
|
Text="Package references changed since the last release. This could be a breaking change and is not allowed in a servicing update. References removed:%0A - @(UnusedBaselinePackageReference, '%0A - ')" />
|
|
|
|
<Error
|
|
Condition="'$(TargetFrameworkIdentifier)' != '.NETFramework' AND '%(Reference.Identity)' != '' AND ! Exists('%(Reference.Identity)') AND '$(DisablePackageReferenceRestrictions)' != 'true'"
|
|
Code="MSB3245"
|
|
Text="Could not resolve this reference. Could not locate the package or project for "%(Reference.Identity)". Did you update baselines and dependencies lists? See docs/ReferenceResolution.md for more details." />
|
|
</Target>
|
|
|
|
<PropertyGroup>
|
|
<_CompileTfmUsingReferenceAssemblies>false</_CompileTfmUsingReferenceAssemblies>
|
|
<_CompileTfmUsingReferenceAssemblies
|
|
Condition=" '$(CompileUsingReferenceAssemblies)' != false AND '$(TargetFramework)' == '$(DefaultNetCoreTargetFramework)' ">true</_CompileTfmUsingReferenceAssemblies>
|
|
</PropertyGroup>
|
|
<!--
|
|
If we have a ref/ assembly from dotnet/runtime for an Extension package, use that when compiling but do not reference its assemblies.
|
|
-->
|
|
<ItemGroup
|
|
Condition=" $(_CompileTfmUsingReferenceAssemblies) OR ('$(IsTargetingPackBuilding)' != 'false' AND '$(MSBuildProjectName)' == 'Microsoft.AspNetCore.App.Ref') ">
|
|
<PackageReference Include="Microsoft.Extensions.Internal.Transport"
|
|
Version="$(MicrosoftExtensionsInternalTransportPackageVersion)"
|
|
IsImplicitlyDefined="true"
|
|
IncludeAssets="Compile"
|
|
PrivateAssets="All"
|
|
GeneratePathProperty="true" />
|
|
</ItemGroup>
|
|
|
|
<!-- These targets are used to generate the map of assembly name to project files. See also the /t:GenerateProjectList target in build/repo.targets. -->
|
|
<Target Name="GetReferencesProvided" Returns="@(ProvidesReference)">
|
|
<ItemGroup>
|
|
<_TargetFramework Remove="@(_TargetFramework)" />
|
|
<_TargetFramework Include="$(TargetFramework)" Condition="'$(TargetFramework)' != '' "/>
|
|
<_TargetFramework Include="$(TargetFrameworks)" Condition="'$(TargetFramework)' == '' "/>
|
|
</ItemGroup>
|
|
|
|
<MSBuild Projects="$(MSBuildProjectFullPath)"
|
|
Targets="_GetReferencesProvided"
|
|
Properties="TargetFramework=%(_TargetFramework.Identity)">
|
|
<Output TaskParameter="TargetOutputs" ItemName="ProvidesReference" />
|
|
</MSBuild>
|
|
</Target>
|
|
|
|
<Target Name="_GetReferencesProvided" Returns="@(ProvidesReference)">
|
|
<Error
|
|
Condition=" '$(IsAspNetCoreApp)' == 'true' AND '$(IsImplementationProject)' == 'true' AND
|
|
!$(HasReferenceAssembly) AND '$(TargetFramework)' == '$(DefaultNetCoreTargetFramework)' "
|
|
Text="All assemblies which have set IsAspNetCoreApp=true should produce a reference assembly for default TFM." />
|
|
<Error Condition=" '$(IsAspNetCoreApp)' == 'true' AND '$(IsImplementationProject)' != 'true' "
|
|
Text="Only implementation projects should set IsAspNetCoreApp=true." />
|
|
<Error Condition=" '$(IsAspNetCoreApp)' != 'true' AND $(HasReferenceAssembly) "
|
|
Text="Only projects in the shared framework i.e. IsAspNetCoreApp==true should produce a reference assembly." />
|
|
<Warning Condition=" '$(IsProjectReferenceProvider)' == 'true' AND '$(AssemblyName)' != '$(MSBuildProjectName)' "
|
|
Text="Project name "$(MSBuildProjectName)" is confusing; assembly is named "$(AssemblyName)"." />
|
|
|
|
<ItemGroup Condition=" '$(IsProjectReferenceProvider)' == 'true' ">
|
|
<ProvidesReference Include="$(AssemblyName)">
|
|
<IsAspNetCoreApp>$([MSBuild]::ValueOrDefault($(IsAspNetCoreApp),'false'))</IsAspNetCoreApp>
|
|
<IsPackable>$([MSBuild]::ValueOrDefault($(IsPackable),'false'))</IsPackable>
|
|
<ProjectFileRelativePath>$([MSBuild]::MakeRelative($(RepoRoot), $(MSBuildProjectFullPath)))</ProjectFileRelativePath>
|
|
</ProvidesReference>
|
|
</ItemGroup>
|
|
</Target>
|
|
|
|
<!-- This is used by the eng/scripts/AddAllProjectRefsToSolution.ps1 script to traverse the ProjectRef graph -->
|
|
<PropertyGroup>
|
|
<_CustomCollectProjectReferenceDependsOn Condition="'$(TargetFramework)' != ''">ResolveProjectReferences</_CustomCollectProjectReferenceDependsOn>
|
|
</PropertyGroup>
|
|
<Target Name="_CustomCollectProjectReference" DependsOnTargets="$(_CustomCollectProjectReferenceDependsOn)" Returns="$(MSBuildProjectFullPath);@(_MSBuildProjectReferenceExistent)">
|
|
<ItemGroup>
|
|
<_TargetFrameworks Include="$(TargetFrameworks)" />
|
|
</ItemGroup>
|
|
<MSBuild Condition="'$(TargetFramework)' == ''"
|
|
Targets="_CustomCollectProjectReference"
|
|
BuildInParallel="true"
|
|
Projects="$(MSBuildProjectFullPath)"
|
|
Properties="TargetFramework=%(_TargetFrameworks.Identity)"
|
|
RebaseOutputs="True">
|
|
<Output TaskParameter="TargetOutputs" ItemName="_MSBuildProjectReferenceExistent" />
|
|
</MSBuild>
|
|
<MSBuild Condition="'$(TargetFramework)' != ''"
|
|
Targets="_CustomCollectProjectReference"
|
|
BuildInParallel="true"
|
|
SkipNonexistentTargets="true"
|
|
Projects="@(_MSBuildProjectReferenceExistent)"
|
|
RebaseOutputs="True">
|
|
<Output TaskParameter="TargetOutputs" ItemName="_MSBuildProjectReferenceExistent" />
|
|
</MSBuild>
|
|
</Target>
|
|
</Project>
|