GitTools / GitReleaseNotes

Easily generate release notes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Allow /format "some format here"

ferventcoder opened this issue · comments

To be specified for line notes and headers. Not everyone wants them to be specified the same way and rather than proposing to change the default, allow the ability to override the defaults.

for headers:

### {{tag}} ({{releasedate}})

I like for line notes

 * {{summary}} - [{{id}}]({{url}})

so it would be something like /headerFormat "### {(tag}} ({{releasedate}})" /issueFormat " * {{summary}} - [{{id}}]({{url}})"

I needed another format too, so I made a tool which parse the semantic release notes generated by GitReleaseNotes and allow to define a custom liquid template to format a markdown or html file.

I assume you saw this @laedit as you have been participating in the conversation but avanderhoorn/Semantic-Release-Notes#11 (comment)

I just think it is weird that you have to render markdown to another markdown file which is no longer a semantic release notes as you want a different header size.. Once we fix the spec then we can fix GitReleaseNotes and then the Semantic release notes parser you have created becomes a read/write model to make it easier (which I will use for GitReleaseNotes most likely). As you can just use a normal markdown renderer to render it as html, then it works in Jekyll etc.

I understand and I'm ok with that but in my case I like to have a big ReleaseNotes.md with all versions and use only the last version release notes formatted specifically for GitHub release for example, so a double processing is unavoidable.
The first goal of my tool is not to have a valid semantic release notes at the end since the formating is free, only to parse one.

I think I am after the same thing as you. I was thinking the current release is built up in ReleaseNotes.md then when you release you take that working version, fix the title with the release version and date then take it's contents and put into a github release.

How would your workflow work?

My workflow isn't fixed, but generally once in a while I update my ReleaseNotes.md with GitRealeaseNotes and make some modification if needed. On release I take the first release (right now the first section because like you said the multiple releases is not handled), process it if I want a particular format and put it on GitHub release in markdown and/or as an HTML file if I release a zip with an executable.