Add a PostAction to support modifying Json files in CLI templates #29880

fgheysels · 2023-01-11T12:52:04Z

The DotnetModifyJsonPostActionProcessor PostAction allows dotnet template authors to modify JSON (existing) JSON files when creating a new project.

…gheysels/dotnet-sdk into frgh/feat/5831_json_postaction

ghost · 2023-01-11T12:52:12Z

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

dnfadmin · 2023-01-11T12:52:19Z

All CLA requirements met.

fgheysels · 2023-01-12T12:29:58Z

src/Cli/dotnet/commands/dotnet-new/PostActions/DotnetModifyJsonPostActionProcessor.cs

+            return node;
+        }
+
+        private static IReadOnlyList<string> FindFilesAtOrAbovePath(


I could get rid of this code if we could have an overload of the FindFilesAtOrAbovePath method that exists in the FileFindHelpers class

Feel free to open a PR on the Template Engine to add an over load for the FindFilesAtAbovePath. We can keep this function here until the Template Engine PR is complete for the overloading function.

src/Tests/dotnet-new.Tests/PostActionTests.cs

src/Tests/Microsoft.TemplateEngine.Cli.UnitTests/Microsoft.TemplateEngine.Cli.UnitTests.csproj

src/Cli/Microsoft.TemplateEngine.Cli/PostActionProcessors/AddJsonPropertyPostActionProcessor.cs

YuliiaKovalova · 2023-04-27T10:41:17Z

Could you add post-action info to templating repo?
https://github.com/dotnet/templating/wiki/Post-Action-Registry

src/Cli/Microsoft.TemplateEngine.Cli/PostActionProcessors/AddJsonPropertyPostActionProcessor.cs

YuliiaKovalova · 2023-05-02T12:31:55Z

looks good to me!

fgheysels · 2023-05-02T14:47:07Z

Could you add post-action info to templating repo? https://github.com/dotnet/templating/wiki/Post-Action-Registry

So, that's a PR In another repository ?
Wil do!

vlada-shubina

Thank you for the contribution!

vlada-shubina · 2023-05-02T15:34:11Z

src/Tests/Microsoft.TemplateEngine.Cli.UnitTests/Microsoft.TemplateEngine.Cli.UnitTests.csproj

+    <PackageReference Include="Verify.XUnit" Version="19.8.0" />
+    <PackageReference Include="Verify.DiffPlex" Version="2.1.0" />


similarly to FakeItEasy, do not specify the versions here. They are managed by dependabot.

@fgheysels , it looks like you have the last step here:
https://github.com/dotnet/sdk/pull/29880/checks?check_run_id=13200057848

Yes, I had to verify something with my employer. Done now.

src/Cli/Microsoft.TemplateEngine.Cli/PostActionProcessors/AddJsonPropertyPostActionProcessor.cs

fgheysels · 2023-05-03T12:21:45Z

Could you add post-action info to templating repo? https://github.com/dotnet/templating/wiki/Post-Action-Registry

So, that's a PR In another repository ? Wil do!

I've cloned the wiki locally and added some documentation for the new postaction.
Afterwards, I wanted to push my branch, but got the message that I'm not allowed to push my branch to the remote. So, I created a fork and pushed the changes to my fork.
Now, I want to create a PR for the wiki changes, but GitHub is a bit confused as it says that there is nothing to compare (commit histories are entirely different) although it also shows the changes I've made in a diff window. Unfortunately, it doesn't allow me to create a PR:

So, any help here is appreciated :)

YuliiaKovalova · 2023-05-03T12:25:47Z

Could you add post-action info to templating repo? https://github.com/dotnet/templating/wiki/Post-Action-Registry

So, that's a PR In another repository ? Wil do!

I've cloned the wiki locally and added some documentation for the new postaction. Afterwards, I wanted to push my branch, but got the message that I'm not allowed to push my branch to the remote. So, I created a fork and pushed the changes to my fork. Now, I want to create a PR for the wiki changes, but GitHub is a bit confused as it says that there is nothing to compare (commit histories are entirely different) although it also shows the changes I've made in a diff window. Unfortunately, it doesn't allow me to create a PR:

So, any help here is appreciated :)

You need to fork the repo , commit changes and create PR from the fork to dotnet/templating repo.

fgheysels · 2023-05-04T08:40:27Z

Could you add post-action info to templating repo? https://github.com/dotnet/templating/wiki/Post-Action-Registry

So, that's a PR In another repository ? Wil do!

I've cloned the wiki locally and added some documentation for the new postaction. Afterwards, I wanted to push my branch, but got the message that I'm not allowed to push my branch to the remote. So, I created a fork and pushed the changes to my fork. Now, I want to create a PR for the wiki changes, but GitHub is a bit confused as it says that there is nothing to compare (commit histories are entirely different) although it also shows the changes I've made in a diff window. Unfortunately, it doesn't allow me to create a PR:

So, any help here is appreciated :)

You need to fork the repo , commit changes and create PR from the fork to dotnet/templating repo.

I've done that. However, when you fork a repo, the wiki is not forked with it.
So, I've followed these steps. I've now the original wiki in my fork, and updated the docs in my fork.

However, I cannot create a PR as the changes to the wiki are not taken into account when creating a PR. The wiki is a separate repository, so that makes sense. There doesn't seem to be an option to create a PR for the wiki repo.

fgheysels · 2023-05-04T08:53:57Z

@dotnet-policy-service agree

YuliiaKovalova · 2023-05-04T09:23:02Z

Could you add post-action info to templating repo? https://github.com/dotnet/templating/wiki/Post-Action-Registry

So, that's a PR In another repository ? Wil do!

I've cloned the wiki locally and added some documentation for the new postaction. Afterwards, I wanted to push my branch, but got the message that I'm not allowed to push my branch to the remote. So, I created a fork and pushed the changes to my fork. Now, I want to create a PR for the wiki changes, but GitHub is a bit confused as it says that there is nothing to compare (commit histories are entirely different) although it also shows the changes I've made in a diff window. Unfortunately, it doesn't allow me to create a PR:

So, any help here is appreciated :)

You need to fork the repo , commit changes and create PR from the fork to dotnet/templating repo.

I've done that. However, when you fork a repo, the wiki is not forked with it. So, I've followed these steps. I've now the original wiki in my fork, and updated the docs in my fork.

However, I cannot create a PR as the changes to the wiki are not taken into account when creating a PR. The wiki is a separate repository, so that makes sense. There doesn't seem to be an option to create a PR for the wiki repo.

Please point me to the changes in your fork and I will transfer them to our repo.
Thank you for the contribution!

fgheysels · 2023-05-04T12:00:20Z

Could you add post-action info to templating repo? https://github.com/dotnet/templating/wiki/Post-Action-Registry

So, that's a PR In another repository ? Wil do!

I've cloned the wiki locally and added some documentation for the new postaction. Afterwards, I wanted to push my branch, but got the message that I'm not allowed to push my branch to the remote. So, I created a fork and pushed the changes to my fork. Now, I want to create a PR for the wiki changes, but GitHub is a bit confused as it says that there is nothing to compare (commit histories are entirely different) although it also shows the changes I've made in a diff window. Unfortunately, it doesn't allow me to create a PR:

So, any help here is appreciated :)

You need to fork the repo , commit changes and create PR from the fork to dotnet/templating repo.

I've done that. However, when you fork a repo, the wiki is not forked with it. So, I've followed these steps. I've now the original wiki in my fork, and updated the docs in my fork.
However, I cannot create a PR as the changes to the wiki are not taken into account when creating a PR. The wiki is a separate repository, so that makes sense. There doesn't seem to be an option to create a PR for the wiki repo.

Please point me to the changes in your fork and I will transfer them to our repo. Thank you for the contribution!

Looks like you also cannot find the commit on the wiki repo.
Anyway, this is the end result of my changes:
https://github.com/fgheysels/templating/wiki/Post-Action-Registry

fgheysels added 24 commits January 6, 2023 17:09

First implementation of DotNetModifyJsonPostActionProcessor

f5576d5

fix typo

6f3660e

tests are implemented as theory

5a279a9

small improvement

29a112b

refactor

9483c7d

Additional testcases

39ef03c

unnecessary using

b8c3543

localizable strings

d92f5e6

Output error information on missing arguments

cc522e3

improve testcases

a3cbb1f

additional testcase

dff7a34

additional testcase

84d494f

Merge branch 'frgh/feat/5831_json_postaction' of https://github.com/f…

88243c9

…gheysels/dotnet-sdk into frgh/feat/5831_json_postaction

small code improvement

7e3c9c6

Initialize ModifyJsonFile post action

99855b0

Output success message

c3346aa

artifacts for basic end-to-end-test

89820ca

additional unit-test

59a5c41

JSON serializer should not encode non ascii chars

0154427

artificats for modifyjson end-to-end tests

6b992c9

Finalize test with multiple projects

0cfba9a

explicit test if source-replacement can be done within new json property

bfa3543

Additional tests

7fc3a1d

Remove embedded resource ref in csproj

3558734

fgheysels changed the base branch from main to release/7.0.2xx January 11, 2023 12:52

fgheysels mentioned this pull request Jan 11, 2023

PostAction for modifying the deployment.template.json file in IoT Edge solutions dotnet/templating#5831

Closed

fgheysels commented Jan 12, 2023

View reviewed changes

maridematte changed the base branch from release/7.0.2xx to main January 12, 2023 23:20

fgheysels requested a review from a team as a code owner April 26, 2023 10:18

YuliiaKovalova reviewed Apr 27, 2023

View reviewed changes

src/Cli/Microsoft.TemplateEngine.Cli/PostActionProcessors/AddJsonPropertyPostActionProcessor.cs Outdated Show resolved Hide resolved

fgheysels added 5 commits April 28, 2023 13:30

revert change in PostActionTests

eb6fc6b

Extract Action argument validation

cb9979f

blank lines between properties are required

db1a7a1

ctor / property order

5bc39fa

versioning of test packages

6e5a5ee

build-analysis bot mentioned this pull request May 2, 2023

Errors restoring runtime pack #32038

Closed

vlada-shubina approved these changes May 2, 2023

View reviewed changes

fgheysels added 4 commits May 2, 2023 21:49

no version specified for external packages (managed by dependabot)

d2f144e

fix bug on parsing/assigning postaction args

9d2a55d

missing space

0523538

header

68b6726

fgheysels commented May 3, 2023

View reviewed changes

src/Cli/Microsoft.TemplateEngine.Cli/PostActionProcessors/AddJsonPropertyPostActionProcessor.cs Show resolved Hide resolved

YuliiaKovalova and others added 4 commits May 3, 2023 11:35

Update license header AddJsonPropertyPostActionTests.cs

9de9ecf

Update license header AddJsonPropertyPostActionProcessor.cs

bd848e5

updated header

56caba7

merge

4debf98

YuliiaKovalova merged commit cf7aa07 into dotnet:main May 4, 2023

fgheysels deleted the frgh/feat/5831_json_postaction branch May 5, 2023 08:35

		<PackageReference Include="Verify.XUnit" Version="19.8.0" />
		<PackageReference Include="Verify.DiffPlex" Version="2.1.0" />

Add a PostAction to support modifying Json files in CLI templates #29880

Add a PostAction to support modifying Json files in CLI templates #29880

Uh oh!

Conversation

fgheysels commented Jan 11, 2023

Uh oh!

ghost commented Jan 11, 2023

Uh oh!

dnfadmin commented Jan 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fgheysels Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

maridematte Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

YuliiaKovalova commented Apr 27, 2023

Uh oh!

Uh oh!

YuliiaKovalova commented May 2, 2023

Uh oh!

fgheysels commented May 2, 2023

Uh oh!

vlada-shubina left a comment

Choose a reason for hiding this comment

Uh oh!

vlada-shubina May 2, 2023

Choose a reason for hiding this comment

Uh oh!

fgheysels May 2, 2023

Choose a reason for hiding this comment

Uh oh!

YuliiaKovalova May 3, 2023

Choose a reason for hiding this comment

Uh oh!

fgheysels May 4, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fgheysels commented May 3, 2023

Uh oh!

YuliiaKovalova commented May 3, 2023

Uh oh!

fgheysels commented May 4, 2023

Uh oh!

fgheysels commented May 4, 2023

Uh oh!

YuliiaKovalova commented May 4, 2023

Uh oh!

fgheysels commented May 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dnfadmin commented Jan 11, 2023 •

edited

Loading