(GH-217) Additional improvements to fine-grained templates #294

AdmiringWorm · 2020-09-16T10:48:42Z

Depends on PR #292

Description

This pull request adds quite some additional changes, among these changes are:

Change to a seperate class for the actual logic of the template parser (with a factory) (alternatively an absolute path can be passed in to the program to specifically load that file).
Create a template loader to allow both embedded resources and physical files in different locations.
Seperate out the single template file to multiple files that can be overridden alone.
Add a template-dir property in the yaml file to decide where templates are loaded from (or extracted to).
Hide the existing footer yaml properties in the sample (to encourage usage of scriban template files instead)
Improve the generated release notes by removing multiple empty lines (considered bad practice in general, and causes issues with different markdown linters).
I think there was more, but forgot.

Related Issue

Relates to already closed issue #217 (this pull request finishes up that request).

Motivation and Context

To allow more fine-grained release notes.

How Has This Been Tested?

This have been tested through trial and error, mostly with new unit tests but also some basic generation of release notes locally.

Screenshots (if appropriate):

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly. (On my TODO list)
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed. (Not been able to verify the integration tests due to access restriction).

AdmiringWorm · 2020-09-16T11:22:22Z

Build failure is due to codecov (rebased and force pushed in a too short of a timespan).

AdmiringWorm · 2020-09-16T22:57:18Z

@gep13 Documentation is now updated, I believe this is now ready for a review.

codecov-commenter · 2020-09-16T23:01:43Z

Codecov Report

Merging #294 into develop will increase coverage by 0.52%.
The diff coverage is 81.92%.

@@             Coverage Diff             @@
##           develop     #294      +/-   ##
===========================================
+ Coverage    78.36%   78.88%   +0.52%     
===========================================
  Files           54       57       +3     
  Lines         1137     1274     +137     
  Branches       131      160      +29     
===========================================
+ Hits           891     1005     +114     
- Misses         225      247      +22     
- Partials        21       22       +1

Impacted Files	Coverage Δ
...tReleaseManager.Core/Configuration/CreateConfig.cs	`100.00% <ø> (ø)`
...GitReleaseManager.Core/Options/CreateSubOptions.cs	`85.71% <0.00%> (ø)`
...c/GitReleaseManager.Core/Options/InitSubOptions.cs	`0.00% <0.00%> (ø)`
src/GitReleaseManager.Core/Commands/InitCommand.cs	`26.92% <10.00%> (-60.58%)`	⬇️
src/GitReleaseManager.Core/Helpers/FileSystem.cs	`27.77% <50.00%> (+11.11%)`	⬆️
...easeManager.Core/Configuration/ConfigSerializer.cs	`86.66% <72.72%> (-3.34%)`	⬇️
...itReleaseManager.Core/Templates/TemplateFactory.cs	`80.00% <80.00%> (ø)`
...c/GitReleaseManager.Core/Commands/CreateCommand.cs	`100.00% <100.00%> (ø)`
src/GitReleaseManager.Core/Configuration/Config.cs	`100.00% <100.00%> (ø)`
...ReleaseManager.Core/Extensions/StringExtensions.cs	`100.00% <100.00%> (ø)`
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 156a666...6f58eb7. Read the comment docs.

gep13

Just a minor thing that I think needs to be added.

docs/input/docs/configuration/template-configuration.md

gep13 · 2020-12-28T22:02:12Z

@AdmiringWorm based on what I am seeing here, am I right in saying that this change isn't a breaking change? Any existing usage of configuration values in the YAML file should continue to work, right?

gep13 · 2020-12-28T22:06:29Z

@AdmiringWorm looks like some unit tests are now failing as well. Not sure if that is due to some of the changes that I have made in the develop branch or not.

AdmiringWorm · 2020-12-28T22:10:40Z

@AdmiringWorm based on what I am seeing here, am I right in saying that this change isn't a breaking change? Any existing usage of configuration values in the YAML file should continue to work, right?

Correct, there shouldn't be any breaking changes, although the intention is for the template files to eventually replace the configured template strings in the yaml file (but for now, just hiding them when they are default values should be enough).

@AdmiringWorm looks like some unit tests are now failing as well. Not sure if that is due to some of the changes that I have made in the develop branch or not.

Hmm, could be related to those changes, but I need to look into it before I can say for sure.

AdmiringWorm · 2020-12-28T22:31:26Z

I think there might have been a breaking change in the Scriban library (you updated it from 2.1.4 to 3.x), can't seem to find any reference to a breaking change though 😕

The help text for the option have also been updated to mention updated template provider.

This includes both updated logic for the templates, as well as better whitespace handling that have plagued (IMO) the release notes for a long time.

…mplates The hidden properties can still be used, but will not be part of the sample that gets generated when running 'init'.

codecov-io · 2020-12-30T10:28:32Z

Codecov Report

Merging #294 (09c2a6b) into develop (ab75056) will increase coverage by 0.52%.
The diff coverage is 81.92%.

@@             Coverage Diff             @@
##           develop     #294      +/-   ##
===========================================
+ Coverage    78.36%   78.88%   +0.52%     
===========================================
  Files           54       57       +3     
  Lines         1137     1274     +137     
  Branches       131      160      +29     
===========================================
+ Hits           891     1005     +114     
- Misses         225      247      +22     
- Partials        21       22       +1

Impacted Files	Coverage Δ
...tReleaseManager.Core/Configuration/CreateConfig.cs	`100.00% <ø> (ø)`
...GitReleaseManager.Core/Options/CreateSubOptions.cs	`85.71% <0.00%> (ø)`
...c/GitReleaseManager.Core/Options/InitSubOptions.cs	`0.00% <0.00%> (ø)`
src/GitReleaseManager.Core/Commands/InitCommand.cs	`26.92% <10.00%> (-60.58%)`	⬇️
src/GitReleaseManager.Core/Helpers/FileSystem.cs	`27.77% <50.00%> (+11.11%)`	⬆️
...easeManager.Core/Configuration/ConfigSerializer.cs	`86.66% <72.72%> (-3.34%)`	⬇️
...itReleaseManager.Core/Templates/TemplateFactory.cs	`80.00% <80.00%> (ø)`
...c/GitReleaseManager.Core/Commands/CreateCommand.cs	`100.00% <100.00%> (ø)`
src/GitReleaseManager.Core/Configuration/Config.cs	`100.00% <100.00%> (ø)`
...ReleaseManager.Core/Extensions/StringExtensions.cs	`100.00% <100.00%> (ø)`
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab75056...09c2a6b. Read the comment docs.

gep13 · 2020-12-30T10:29:25Z

@AdmiringWorm looks like bumping to 3.3.0 has fixed the issues that we were seeing with this PR.

Will take another look over it later today, and get it merged in.

gep13 · 2020-12-30T10:30:31Z

This was the Scriban issue for reference.

gep13 · 2020-12-30T12:23:26Z

@AdmiringWorm I have no idea why GitVersion is working properly on the CI build, but I am going to YOLO it...

gep13 · 2020-12-30T12:23:41Z

@AdmiringWorm your changes have been merged, thanks for your contribution 👍

Merge pull request #294 from AdmiringWorm/template-improvements (GH-217) Additional improvements to fine-grained templates

AdmiringWorm requested a review from gep13 September 16, 2020 10:59

AdmiringWorm marked this pull request as ready for review September 16, 2020 22:56

gep13 requested changes Dec 28, 2020

View reviewed changes

docs/input/docs/configuration/template-configuration.md Outdated Show resolved Hide resolved

gep13 mentioned this pull request Dec 29, 2020

After updating to Scriban 3.2.2, templates are no longer working scriban/scriban#291

Closed

AdmiringWorm added 10 commits December 30, 2020 10:14

(GH-217) Create text template for generating templates

21eb7f6

(GH-217) Move template logic to its own class(es)

75c2df9

(GH-217) Rename TemplateFilePath option to Template

5ff5cb8

The help text for the option have also been updated to mention updated template provider.

(maint) Update FileSystem class to resolve relative paths

9a383a2

(GH-217) Add option to extract embedded templates

e4bee05

(GH-217) Improve template handling

1d8c098

This includes both updated logic for the templates, as well as better whitespace handling that have plagued (IMO) the release notes for a long time.

(GH-217) Hide footer yaml properties to encourage usage of scriban te…

60bc027

…mplates The hidden properties can still be used, but will not be part of the sample that gets generated when running 'init'.

(docs) Add documentation regarding overriding templates

b9dde95

(docs) Update documentation for init command

c5b4cd2

(GH-217) Fix minor typos

09c2a6b

gep13 added 2 commits December 30, 2020 12:06

(GH-217) Added link to Scriban docs

f4162af

(maint) Fix formatting

23d0f7b

gep13 merged commit bac02d9 into GitTools:develop Dec 30, 2020

gittools-bot pushed a commit that referenced this pull request Dec 30, 2020

Continuous Integration Publish: bac02d9

11f6794

Merge pull request #294 from AdmiringWorm/template-improvements (GH-217) Additional improvements to fine-grained templates

AdmiringWorm deleted the template-improvements branch December 30, 2020 18:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(GH-217) Additional improvements to fine-grained templates #294

(GH-217) Additional improvements to fine-grained templates #294

AdmiringWorm commented Sep 16, 2020 •

edited

Loading

AdmiringWorm commented Sep 16, 2020

AdmiringWorm commented Sep 16, 2020

codecov-commenter commented Sep 16, 2020 •

edited

Loading

gep13 left a comment

gep13 commented Dec 28, 2020

gep13 commented Dec 28, 2020

AdmiringWorm commented Dec 28, 2020

AdmiringWorm commented Dec 28, 2020

codecov-io commented Dec 30, 2020

gep13 commented Dec 30, 2020

gep13 commented Dec 30, 2020

gep13 commented Dec 30, 2020

gep13 commented Dec 30, 2020

(GH-217) Additional improvements to fine-grained templates #294

(GH-217) Additional improvements to fine-grained templates #294

Conversation

AdmiringWorm commented Sep 16, 2020 • edited Loading

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Checklist:

AdmiringWorm commented Sep 16, 2020

AdmiringWorm commented Sep 16, 2020

codecov-commenter commented Sep 16, 2020 • edited Loading

Codecov Report

gep13 left a comment

Choose a reason for hiding this comment

gep13 commented Dec 28, 2020

gep13 commented Dec 28, 2020

AdmiringWorm commented Dec 28, 2020

AdmiringWorm commented Dec 28, 2020

codecov-io commented Dec 30, 2020

Codecov Report

gep13 commented Dec 30, 2020

gep13 commented Dec 30, 2020

gep13 commented Dec 30, 2020

gep13 commented Dec 30, 2020

AdmiringWorm commented Sep 16, 2020 •

edited

Loading

codecov-commenter commented Sep 16, 2020 •

edited

Loading