Make release notes templatable#7
Open
AndersBennedsgaard wants to merge 3 commits intomogensen:mainfrom
Open
Conversation
baprx
added a commit
to baprx/helm-changelog
that referenced
this pull request
Jun 17, 2023
baprx
referenced
this pull request
in baprx/helm-changelog
Jun 17, 2023
…otes-pr-7 feat(#7): Implement templated release notes
This was referenced Apr 13, 2024
darkweaver87
pushed a commit
to darkweaver87/helm-changelog
that referenced
this pull request
Mar 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This changes the way we write the changelog, by implementing
text/template.By default it reads the templates found in
pkg/output/templates/*.gtpl, but this can be changed using the--release-templateflag.I have tried to create templates which creates very similar results as earlier, but some unnecessary whitespace has been removed.
In addition, I have added github.com/Masterminds/sprig/v3 as a dependency, making templates much more powerful (and more similar to Helm templating 😅 )
Ps. it only works for the actual releases and not the entire changelog. So it is not possible to change the title of the file or the autogenerated trailing message yet.