Add changelog generation to release process #454
Merged
Conversation
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
SylvainJuge
approved these changes
Nov 20, 2024
Comment on lines
+220
to
+224
| echo 'notes<<RELNOTESEOF' >> $GITHUB_OUTPUT | ||
| cat CHANGELOG.next-release.md >> $GITHUB_OUTPUT | ||
| printf '\nThis release is based on the following upstream versions:\n\n' >> $GITHUB_OUTPUT | ||
| ./gradlew -q printUpstreamDependenciesMarkdown >> $GITHUB_OUTPUT | ||
| echo 'RELNOTESEOF' >> $GITHUB_OUTPUT |
Member
There was a problem hiding this comment.
[minor] could it be simpler to implement this completely as a gradle task ?
Contributor
Author
There was a problem hiding this comment.
I don't think it would be really simpler because then the gradle task would have to do the file handling, which is more code than cat CHANGELOG.next-release.md.
The multiline support code echo 'notes<<RELNOTESEOF' >> $GITHUB_OUTPUT and echo 'RELNOTESEOF' >> $GITHUB_OUTPUT would still be required, so we wouldn't save much
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
CHANGELOG.next-release.mdto the repository: This file will contain unreleased changesCHANGELOG.mdto the repository: This file will contain changelogs for all released versionsCHANGELOG.next-release.mdwill be prepend with a new heading for the version toCHANGELOG.mdon release AND used for the GH release notesExample:
I've tested the release note generation steps using GH actions in my fork of the repo.