Migrate GenerateFileFromTemplate to Microsoft.DotNet.Build.Tasks.Templating by JunTaoLuo · Pull Request #7403 · dotnet/arcade

JunTaoLuo · 2021-05-18T18:32:11Z

Fixes #204. This will need to be backported to 3.1 and 5.0 after approval

dougbu

My comments are all nits but I would like to hear from @alexperovich and / or @markwilkie before we merge.

dougbu · 2021-05-18T19:17:34Z

/fyi @rainersigwald (re dotnet/msbuild#4018) @ericstj (re #204) @ilyas1974 and @ViktorHofer (re tail end of #135)

dougbu · 2021-05-18T19:24:43Z

@rainersigwald this migrationf from aspnet/BuildTools reminds me of a rather unrelated question: Why is the <JoinItems> task in the .NET SDK and not together with the more general msbuild tasks and targets❔ I'm reminded of the discrepancy when I reach for Remove with MatchOnMetadata (a poorly-documented and limited option) or difficult-to-grok task batching alternatives in projects that don't use that SDK.

rainersigwald · 2021-05-18T19:30:14Z

Why is the <JoinItems> task in the .NET SDK and not together with the more general msbuild tasks and targets❔

It was needed there first. I am not opposed in principle to "promoting" it.

ViktorHofer · 2021-05-18T20:13:47Z

Great to see progress on this 👍

Does one task justify an additional assembly and with it package? Why not add it to the Arcade.Sdk project instead?

ViktorHofer · 2021-05-18T20:21:08Z

That's the implementation that we use in dotnet/runtime: https://github.com/dotnet/runtime/blob/main/src/tasks/installer.tasks/GenerateRunScript.cs which looks simpler. Wouldn't that suffice?

JunTaoLuo · 2021-05-18T20:29:54Z

@ViktorHofer it was mentioned that this task shouldn't be included in the SDK: #204 (comment) so we decided to create a task package instead. As for comparison between GenerateRunScript.cs, this task is more general and can be used to substitute a user specified set of properties instead of just the specific [[RunCommands]] and [[EchoRunCommands]]

ViktorHofer

LGTM. What about tests? :)

JunTaoLuo · 2021-05-18T20:54:36Z

There were no tests in the original implementation, maybe we should not block on that in this PR and file followup to add tests?

ViktorHofer · 2021-05-18T21:05:13Z

There were no tests in the original implementation, maybe we should not block on that in this PR and file followup to add tests?

Sure, works for me.

…lating

…tNet.Build.Tasks.Templating.props Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com> Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

JunTaoLuo · 2021-05-29T07:47:19Z

Hey all, I've addressed the style guidelines and other feedback.

dougbu · 2021-05-29T18:42:51Z

@@ -0,0 +1,29 @@
+<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. -->


/fyi @markwilkie four projects in this repo use a different header:



They should probably be made consistent.

dougbu · 2021-06-03T21:41:40Z

This PR has been reviewed though I don't see any s from Core-Eng folks. Unless I hear different before later tonight, I'll merge. Please sing out w/ objections if you have any.

markwilkie · 2021-06-03T22:04:23Z

While I have no context on the code itself, the intent is good with me. Assuming the right testing has happened, I'm find w/ merging.

ChadNedzlek · 2021-06-03T22:10:18Z

+        /// The destination for the generated file.
+        /// </summary>
+        [Required]
+        [Output]


This "Output" is not correct, it's an input parameter. It's not returned by this task.

Looks like we use it as output here: https://github.com/dotnet/aspnetcore/blob/52eff90fbcfca39b7eb58baad597df6a99a542b0/src/ProjectTemplates/GenerateContent.targets#L45-L52.

Though I think it may be more correct to set the value to the value escaped by https://github.com/aspnet/BuildTools/blame/main/src/Internal.AspNetCore.BuildTasks/GenerateFileFromTemplate.cs#L55.

We could probably also separate it out into a separate out parameter like ResolvedOutputPath or EscapedOutputPath but so far we haven't run into any issues in our builds due to this being an Output parameter so I would prefer if we don't block on this change and file followup issues to address.

This path is never set by this code. Marking it output is incorrect, since it doesn't actually output anything. We should not be checking in new, incorrect, code.

ViktorHofer · 2021-06-09T20:55:52Z

🎉🎉🎉

…lating (#7403) Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com>

…s.Templating (#7503) * Migrate GenerateFileFromTemplate to Microsoft.DotNet.Build.Tasks.Templating (#7403) Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com> * Cherry-pick fixes * TFM update * Fix syntax for older SDKs * More syntax fixes Co-authored-by: John Luo <johluo@microsoft.com> Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com>

…s.Templating (#7502) * Migrate GenerateFileFromTemplate to Microsoft.DotNet.Build.Tasks.Templating (#7403) Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com> * 5.0 fixes * TFM update Co-authored-by: John Luo <johluo@microsoft.com> Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com> Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com>

JunTaoLuo requested review from dougbu and markwilkie May 18, 2021 18:32

dougbu approved these changes May 18, 2021

View reviewed changes

dougbu requested a review from alexperovich May 18, 2021 19:11

rainersigwald approved these changes May 18, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/GenerateFileFromTemplate.cs Outdated

ViktorHofer reviewed May 18, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/build/Microsoft.DotNet.Build.Tasks.Templating.props Outdated

ViktorHofer reviewed May 18, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/build/Microsoft.DotNet.Build.Tasks.Templating.props Outdated

ViktorHofer reviewed May 18, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/GenerateFileFromTemplate.cs Outdated

ViktorHofer approved these changes May 18, 2021

View reviewed changes

alexperovich reviewed May 18, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/Microsoft.DotNet.Build.Tasks.Templating.csproj

ChadNedzlek reviewed May 18, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/GenerateFileFromTemplate.cs Outdated

ViktorHofer reviewed May 19, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/Microsoft.DotNet.Build.Tasks.Templating.csproj

lukas-lansky mentioned this pull request May 19, 2021

Taking over runtime's C# style rule configuration #7410

Merged

John Luo and others added 8 commits May 29, 2021 00:08

Migrate GenerateTemplateFromFile to Microsoft.DotNet.Build.Tasks.Temp…

4c2efe4

…lating

Update src/Microsoft.DotNet.Build.Tasks.Templating/build/Microsoft.Do…

fd680db

…tNet.Build.Tasks.Templating.props Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

Apply suggestions from code review

97ffb60

Co-authored-by: Doug Bunting <6431421+dougbu@users.noreply.github.com> Co-authored-by: Rainer Sigwald <raines@microsoft.com> Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

Update GenerateFileFromTemplate.cs

7d4af53

Update MSBuildListSplitter.cs

8d5d7ee

Update Microsoft.DotNet.Build.Tasks.Templating.csproj

f911aae

Import

3c0c88d

Update style and address feedback

ceaa936

JunTaoLuo force-pushed the johluo/template branch from 76b2505 to ceaa936 Compare May 29, 2021 07:46

ViktorHofer approved these changes May 29, 2021

View reviewed changes

dougbu reviewed May 29, 2021

View reviewed changes

Add another warning

d4ae2a3

JunTaoLuo requested a review from alexperovich June 1, 2021 06:03

ChadNedzlek suggested changes Jun 3, 2021

View reviewed changes

ChadNedzlek reviewed Jun 3, 2021

View reviewed changes

Comment thread src/Microsoft.DotNet.Build.Tasks.Templating/GenerateFileFromTemplate.cs

dougbu mentioned this pull request Jun 4, 2021

Arpow: GenerateFileFromTemplate task causes BuildTools prebuilt dotnet/aspnetcore#32492

Closed

Separate output property

f5eb4e3

JunTaoLuo changed the title ~~Migrate GenerateTemplateFromFile to Microsoft.DotNet.Build.Tasks.Templating~~ Migrate GenerateFileFromTemplate to Microsoft.DotNet.Build.Tasks.Templating Jun 8, 2021

Add tests

de311ce

ChadNedzlek approved these changes Jun 9, 2021

View reviewed changes

JunTaoLuo merged commit e81d8c9 into main Jun 9, 2021

JunTaoLuo deleted the johluo/template branch June 9, 2021 20:49

ViktorHofer mentioned this pull request Jun 9, 2021

Replace usages of templating mechanism inside msbuild code paths with GenerateFileFromTemplate dotnet/runtime#53959

Closed

danmoseley mentioned this pull request Feb 7, 2022

Add RuntimeConfiguration.NotRelease danmoseley/arcade#1

Closed

1 task

		@@ -0,0 +1,29 @@
		<!-- Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. -->

Uh oh!

Conversation

JunTaoLuo commented May 18, 2021

Uh oh!

dougbu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dougbu commented May 18, 2021

Uh oh!

dougbu commented May 18, 2021

Uh oh!

Uh oh!

rainersigwald commented May 18, 2021

Uh oh!

ViktorHofer commented May 18, 2021

Uh oh!

Uh oh!

Uh oh!

ViktorHofer commented May 18, 2021

Uh oh!

JunTaoLuo commented May 18, 2021

Uh oh!

Uh oh!

ViktorHofer left a comment

Choose a reason for hiding this comment

Uh oh!

JunTaoLuo commented May 18, 2021

Uh oh!

ViktorHofer commented May 18, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JunTaoLuo commented May 29, 2021

Uh oh!

Uh oh!

dougbu May 29, 2021

Choose a reason for hiding this comment

Uh oh!

dougbu commented Jun 3, 2021

Uh oh!

markwilkie commented Jun 3, 2021

Uh oh!

ChadNedzlek Jun 3, 2021

Choose a reason for hiding this comment

Uh oh!

JunTaoLuo Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

JunTaoLuo Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

ChadNedzlek Jun 4, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ViktorHofer commented Jun 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants