[templates] remove Directory.Build.targets, add @(ProjectCapability) by jonathanpeppers · Pull Request #1433 · dotnet/maui

jonathanpeppers · 2021-06-23T16:52:24Z

Description of Change

The Directory.Build.targets files in the templates were a collection
of workarounds that were needed until .NET MAUI was a workload. When
.NET MAUI was a NuGet package, this was the only way to set required
values for the IDE before NuGet restore. In the early days, you had to
unload/reload MAUI projects after NuGet restore.

We can remove Directory.Build.targets from templates now, and
consolidate @(ProjectCapability) so this is defined by the workload.

The following capabilities are defined for the IDE:

Maui
MauiSingleProject, LaunchProfiles, XamarinStaticLaunchProfiles
when $(SingleProject) is true

These new capabilities are defined to identify projects (via telemetry)
that bring in portions of .NET MAUI:

MauiAssets
MauiBlazor
MauiCore
MauiEssentials

Other changes:

$(_KeepLaunchProfiles) is set by default when $(SingleProject)
is true.
WinUI workarounds are moved into WinUI.SingleProject.targets.
Fixed sdk-manifests casing for src/DotNet/DotNet.csproj -t:Install

PR Checklist

Does this PR touch anything that might affect accessibility?

No

jonathanpeppers · 2021-06-23T16:53:25Z

+      This allows easily toggling of debug target TFM by selecting the platform.
+      If removed, top level debug targets show as a list of devices for the selected TFM.
+      -->
+    <ProjectCapability Include="XamarinStaticLaunchProfiles" />


/cc @joj @tondat this is probably the portion related to the IDE.

@tondat I tried to mark you as a reviewer, but maybe you don't have contributor access on this repo.

@tondat is suggesting in Teams we might change to:

<ItemGroup> <ProjectCapability Include="MauiSingleProject" /> <ProjectCapability Include="LaunchProfilesGroupByPlatformFilters"/> <ProjectCapability Include="BuildOnlyActiveTargetFrameworkOnDebug" /> </ItemGroup>

Also, a target that would improve the developer loop (until we get the appropriate Project System changes);

<Target Name="ComputeXamarinTargetFrameworks" BeforeTargets="_ComputeTargetFrameworkItems"> <PropertyGroup> <TargetFrameworks Condition="'$(TargetFramework)' == '' AND '$(_SelectedTargetFramework)' != ''">$(_SelectedTargetFramework)</TargetFrameworks> </PropertyGroup> <Message Text="SelectedTargetFramework = $(_SelectedTargetFramework)" /> <Message Text="TargetFramework = $(TargetFramework)" /> <Message Text="TargetFrameworks = $(TargetFrameworks)" /> <Message Text="BuildingInsideVisualStudio = $(BuildingInsideVisualStudio)" /> </Target>

I'll want to test this target a bit, and probably refactor it.

Final capabilities might be:

<ItemGroup> <ProjectCapability Include="MauiSingleProject" /> <ProjectCapability Include="XamarinStaticLaunchProfiles" Condition=" '$(VisualStudioVersion)' < '17.0' " /> <ProjectCapability Include="LaunchProfilesGroupByPlatformFilters" Condition=" '$(VisualStudioVersion)' >= '17.0' " /> <ProjectCapability Include="BuildOnlyActiveTargetFrameworkOnDebug" /> </ItemGroup>

LaunchProfilesGroupByPlatformFilters is Dev17-only, and you can't have XamarinStaticLaunchProfiles at the same time.

jonathanpeppers · 2021-06-24T19:50:39Z

ComputeXamarinTargetFrameworks target

It does not appear that adding this target will currently work:

<Target Name="ComputeXamarinTargetFrameworks" BeforeTargets="_ComputeTargetFrameworkItems">
  <PropertyGroup>
    <TargetFrameworks Condition="'$(TargetFramework)' == '' AND '$(_SelectedTargetFramework)' != ''">$(_SelectedTargetFramework)</TargetFrameworks>
  </PropertyGroup>
  <Message Text="SelectedTargetFramework = $(_SelectedTargetFramework)" />
  <Message Text="TargetFramework = $(TargetFramework)" />
  <Message Text="TargetFrameworks = $(TargetFrameworks)" />
  <Message Text="BuildingInsideVisualStudio = $(BuildingInsideVisualStudio)" />
</Target>

This needs to run in the "outer" build when $(TargetFramework) is blank and $(TargetFrameworks) plural is set. The "outer" build does not even load .NET workloads, those are loaded when $(TargetFramework) is set in the "inner" build. I currently do not see a way to provide this target from MAUI.

ProjectCapability

I think the current logic here is right, but my IDE isn't working as expected. I don't have a way to select my Android emulator, it fails to deploy when I hit the Play button:

TBD if this is an IDE issue, or something else related to workloads.

jonathanpeppers · 2021-06-28T21:19:34Z

$(TargetPlatformIdentifier) changed to Android, proper case, and that caused the IDE issue. See:

Redth · 2021-07-20T21:03:43Z

@@ -10,20 +10,6 @@
    <PublishTrimmed Condition=" '$(TargetFramework)' == 'net6.0-ios' or '$(TargetFramework)' == 'net6.0-maccatalyst' ">false</PublishTrimmed>


@mattleibow can we remove this now?

Maybe. I know I did in my pr and I think the issue was that we were using Xcode 12. Now with Xcode 13 all over, we probably can remove it.

mattleibow · 2021-07-22T23:12:13Z

+  <Target Name="ValidateWinUIPlatform" />
+  <Target Name="BinPlaceBootstrapDll" />


Does this come in late enough? The WinUI targets from the nugets create this target, and we have to overwrite with a dummy.

This is imported as late as a workload can do it:

maui/src/Workload/Microsoft.Maui.Controls.Sdk/Sdk/Microsoft.Maui.Controls.Sdk.After.targets

Line 9 in f95c2e5

<Import Project="WinUI.targets" Condition=" '$(TargetPlatformIdentifier)' == 'windows' " />

maui/src/Workload/Microsoft.Maui.Controls.Sdk/Sdk/Microsoft.Maui.Controls.Sdk.targets

Lines 14 to 16 in f95c2e5

<PropertyGroup>

<AfterMicrosoftNETSdkTargets>$(AfterMicrosoftNETSdkTargets);$(MSBuildThisFileDirectory)Microsoft.Maui.Controls.Sdk.After.targets</AfterMicrosoftNETSdkTargets>

</PropertyGroup>

We'd need to test, but if it doesn't work we'd have to put the Directory.Build.targets back.

mattleibow · 2021-07-23T02:53:02Z

/azp run

azure-pipelines · 2021-07-23T02:53:16Z

Azure Pipelines successfully started running 1 pipeline(s).

The `Directory.Build.targets` files in the templates were a collection of workarounds that were needed until .NET MAUI was a workload. When .NET MAUI was a NuGet package, this was the only way to set required values for the IDE before NuGet restore. In the early days, you had to unload/reload MAUI projects after NuGet restore. We can remove `Directory.Build.targets` from templates now, and consolidate `@(ProjectCapability)` so this is defined by the workload. The following capabilities are defined for the IDE: * `Maui` * When `$(SingleProject)` is `true`: * `MauiSingleProject`, `LaunchProfiles` * `XamarinStaticLaunchProfiles` older than Dev17 * `LaunchProfilesGroupByPlatformFilters` otherwise These new capabilities are defined to identify projects (via telemetry) that bring in portions of .NET MAUI: * `MauiAssets` * `MauiBlazor` * `MauiCore` * `MauiEssentials` Other changes: * `$(_KeepLaunchProfiles)` is set by default when `$(SingleProject)` is `true`. * WinUI workarounds are moved into `WinUI.SingleProject.targets`. * Fixed `sdk-manifests` casing for `src/DotNet/DotNet.csproj -t:Install`

jonathanpeppers requested review from joj and mattleibow June 23, 2021 16:52

jonathanpeppers commented Jun 23, 2021

View reviewed changes

Redth approved these changes Jun 23, 2021

View reviewed changes

Redth self-requested a review June 23, 2021 18:18

jonathanpeppers marked this pull request as draft June 23, 2021 18:50

jonathanpeppers force-pushed the template-directory.build.targets branch from c936c6d to c53e06d Compare June 24, 2021 19:46

jonathanpeppers force-pushed the template-directory.build.targets branch from c53e06d to b5033f1 Compare June 30, 2021 20:02

mattleibow reviewed Jul 1, 2021

View reviewed changes

Comment thread .nuspec/Microsoft.Maui.Controls.SingleProject.targets

Redth force-pushed the template-directory.build.targets branch from b5033f1 to db88124 Compare July 20, 2021 21:02

Redth reviewed Jul 20, 2021

View reviewed changes

Redth marked this pull request as ready for review July 21, 2021 01:33

Redth requested a review from Eilon as a code owner July 21, 2021 01:33

Redth reviewed Jul 21, 2021

View reviewed changes

Comment thread Directory.Build.targets Outdated

Redth added this to the 6.0.100-preview.7 milestone Jul 21, 2021

mattleibow reviewed Jul 22, 2021

View reviewed changes

Redth approved these changes Jul 26, 2021

View reviewed changes

jonathanpeppers and others added 4 commits July 26, 2021 18:29

Remove CI trimming workaround

acffb4a

Update WinUI.SingleProject.targets

06b4d8c

Update Directory.Build.targets

72f5134

Redth force-pushed the template-directory.build.targets branch from 24a67a3 to 72f5134 Compare July 26, 2021 22:30

mattleibow approved these changes Jul 26, 2021

View reviewed changes

Redth merged commit f835baf into dotnet:main Jul 26, 2021

github-actions Bot locked and limited conversation to collaborators Dec 26, 2023

samhouts added the fixed-in-6.0.100-preview.7.3 Look for this fix in 6.0.100-preview.7.3! label Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[templates] remove Directory.Build.targets, add @(ProjectCapability)#1433

[templates] remove Directory.Build.targets, add @(ProjectCapability)#1433
Redth merged 4 commits into
dotnet:mainfrom
jonathanpeppers:template-directory.build.targets

jonathanpeppers commented Jun 23, 2021

Uh oh!

jonathanpeppers Jun 23, 2021

Uh oh!

jonathanpeppers Jun 23, 2021

Uh oh!

jonathanpeppers Jun 23, 2021

Uh oh!

jonathanpeppers commented Jun 24, 2021

Uh oh!

jonathanpeppers commented Jun 28, 2021

Uh oh!

Uh oh!

Redth Jul 20, 2021

Uh oh!

mattleibow Jul 20, 2021

Uh oh!

Uh oh!

mattleibow Jul 22, 2021

Uh oh!

jonathanpeppers Jul 23, 2021

Uh oh!

mattleibow commented Jul 23, 2021

Uh oh!

azure-pipelines Bot commented Jul 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -10,20 +10,6 @@
		<PublishTrimmed Condition=" '$(TargetFramework)' == 'net6.0-ios' or '$(TargetFramework)' == 'net6.0-maccatalyst' ">false</PublishTrimmed>

		<Target Name="ValidateWinUIPlatform" />
		<Target Name="BinPlaceBootstrapDll" />

	<PropertyGroup>
	<AfterMicrosoftNETSdkTargets>$(AfterMicrosoftNETSdkTargets);$(MSBuildThisFileDirectory)Microsoft.Maui.Controls.Sdk.After.targets</AfterMicrosoftNETSdkTargets>
	</PropertyGroup>

Uh oh!

Conversation

jonathanpeppers commented Jun 23, 2021

Description of Change

PR Checklist

Does this PR touch anything that might affect accessibility?

Uh oh!

jonathanpeppers Jun 23, 2021

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers Jun 23, 2021

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers Jun 23, 2021

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers commented Jun 24, 2021

ComputeXamarinTargetFrameworks target

ProjectCapability

Uh oh!

jonathanpeppers commented Jun 28, 2021

Uh oh!

Uh oh!

Redth Jul 20, 2021

Choose a reason for hiding this comment

Uh oh!

mattleibow Jul 20, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mattleibow Jul 22, 2021

Choose a reason for hiding this comment

Uh oh!

jonathanpeppers Jul 23, 2021

Choose a reason for hiding this comment

Uh oh!

mattleibow commented Jul 23, 2021

Uh oh!

azure-pipelines Bot commented Jul 23, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants