github-release-notes
github-release-notes copied to clipboard
Add a custom template for the release note text pushed to github
Hi following instructions in https://github-tools.github.io/github-release-notes/options.html I tried to customize the header text in order to have a default text in the github release note using the "release" template. However it seems to act only on the changelog.md and not on the release note on github.
Hi @dvojtise,
The release
template option is only for the changelog file generation.
Where would you like to see that text? As the first paragraph of the release body or you would like to customise the actual release title more? (as right now you can just prefix it)
Hi I was thinking about some text at the beginning of the release body. Typically, to add some general instructions about where the user can find the corresponding binaries (not just the sources provided by github) and add some more friendly introduction text about the release.
Ideally, this could be combined with https://github.com/github-tools/github-release-notes/issues/139 in order to provide some initial version of the release note text, then allow to some edition iterations (I use PR as input for the release, so we may have to polish the PR titles separately).
another kind o informations in the text body: In my use case, we use several git repositories for the development, so we add simultaneous tag of the repositories for a given released version. The text would invite the user to see the additional release notes in the companion repositories.
@dvojtise can you see of any automated way of getting that information? Otherwise, I'd consider this issue as a 👍 to #139
There are 2 points in my message:
- one is a :+1: for #139 , (useful for roundtrip/iterative scenario but it does not suppose a customizable initial value for the user modifiable text field)
- the second is a way to initiate the release note body text from a template in grenrc.yml when creating the new note (this template is not automated, just added on creation of the message)
I was referring to #139 mainly because these 2 points may be partially related.