Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow trimming out incompatible ProjectReferences #8459

Merged
merged 7 commits into from
Feb 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,36 @@

using Microsoft.Build.Framework;
using System;
using System.Collections.Generic;
using System.IO;

namespace Microsoft.DotNet.Build.Tasks.TargetFramework
{
public class ChooseBestP2PTargetFrameworkTask : BuildTask
{
[Required]
public string TargetFramework { get; set; }

[Required]
public ITaskItem[] ProjectReferencesWithTargetFrameworks { get; set; }

[Required]
public string RuntimeGraph { get; set; }

[Required]
public string TargetFramework { get; set; }

public bool OmitIncompatibleProjectReferences { get; set; }

[Output]
public ITaskItem[] AnnotatedProjectReferencesWithSetTargetFramework { get; set; }

public override bool Execute()
{
AnnotatedProjectReferencesWithSetTargetFramework = new ITaskItem[ProjectReferencesWithTargetFrameworks.Length];
var annotatedProjectReferencesWithSetTargetFramework = new List<ITaskItem>(ProjectReferencesWithTargetFrameworks.Length);
var targetFrameworkResolver = new TargetFrameworkResolver(RuntimeGraph);

for (int i = 0; i < ProjectReferencesWithTargetFrameworks.Length; i++)
{
ITaskItem projectReference = ProjectReferencesWithTargetFrameworks[i];
string targetFrameworksValue = projectReference.GetMetadata("RawTargetFrameworks");
if (string.IsNullOrEmpty(targetFrameworksValue))
{
targetFrameworksValue = projectReference.GetMetadata("TargetFrameworks");
}
string targetFrameworksValue = projectReference.GetMetadata("TargetFrameworks");

// Allow referencing projects with TargetFrameworks explicitely cleared out, i.e. Microsoft.Build.Traversal.
if (!string.IsNullOrWhiteSpace(targetFrameworksValue))
Expand All @@ -49,6 +48,10 @@ public override bool Execute()
string bestTargetFramework = targetFrameworkResolver.GetBestSupportedTargetFramework(targetFrameworks, referringTargetFramework);
if (bestTargetFramework == null)
{
if (OmitIncompatibleProjectReferences)
{
continue;
}
Log.LogError($"Not able to find a compatible supported target framework for {referringTargetFramework} in Project {Path.GetFileName(projectReference.ItemSpec)}. The Supported Configurations are {string.Join(", ", targetFrameworks)}");
}

Expand All @@ -74,9 +77,10 @@ public override bool Execute()
projectReference.SetMetadata("SkipGetTargetFrameworkProperties", "true");
}

AnnotatedProjectReferencesWithSetTargetFramework[i] = projectReference;
annotatedProjectReferencesWithSetTargetFramework.Add(projectReference);
}

AnnotatedProjectReferencesWithSetTargetFramework = annotatedProjectReferencesWithSetTargetFramework.ToArray();
return !Log.HasLoggedErrors;
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. -->
<Project>
<!-- Add unparsed TargetFrameworks property to GetTargetFrameworks return item metadata to read from it later. -->
<ItemDefinitionGroup>
<_ThisProjectBuildMetadata>
<RawTargetFrameworks>$(TargetFrameworks)</RawTargetFrameworks>
</_ThisProjectBuildMetadata>
</ItemDefinitionGroup>

<PropertyGroup>
<DotNetBuildTasksTargetFrameworkAssembly Condition="'$(MSBuildRuntimeType)' == 'core'">..\tools\netcoreapp3.1\Microsoft.DotNet.Build.Tasks.TargetFramework.dll</DotNetBuildTasksTargetFrameworkAssembly>
<DotNetBuildTasksTargetFrameworkAssembly Condition="'$(MSBuildRuntimeType)' != 'core'">..\tools\net472\Microsoft.DotNet.Build.Tasks.TargetFramework.dll</DotNetBuildTasksTargetFrameworkAssembly>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@
<_ProjectReferenceWithTargetFrameworks Include="@(ProjectReference->WithMetadataValue('SkipGetTargetFrameworkProperties', 'true'))" />
</ItemGroup>

<ChooseBestP2PTargetFrameworkTask TargetFramework="$(TargetFramework)"
ProjectReferencesWithTargetFrameworks="@(_ProjectReferenceWithTargetFrameworks)"
RuntimeGraph="$(RuntimeGraph)">
<ChooseBestP2PTargetFrameworkTask ProjectReferencesWithTargetFrameworks="@(_ProjectReferenceWithTargetFrameworks)"
RuntimeGraph="$(RuntimeGraph)"
TargetFramework="$(TargetFramework)"
OmitIncompatibleProjectReferences="$(OmitIncompatibleProjectReferences)">
<Output TaskParameter="AnnotatedProjectReferencesWithSetTargetFramework" ItemName="_ProjectReferenceWithBestTargetFramework" />
</ChooseBestP2PTargetFrameworkTask>

Expand Down