Release notes improvements #5240
Merged
Conversation
This file contains 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
Generated by 🚫 Danger |
adangel
commented
Oct 24, 2024
adangel
force-pushed
the
release-notes-improvements
branch
from
ad98a8d to
a1ceee7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Describe the PR
This is more like a suggestion and gathering feedback. It theoretically works and we could just use it during release.
There is one script (
release-notes-generate.sh) which will (re-)generate the merged pull requests, dependency updates and stats sections. This is already integrated intodo-release.sh, so that these sections are updated at release time at the latest.However, I'd like to have the release notes always up to date and represent the current state of the repository at any time - and not just during a release.
I've therefore added
release-notes-add-pr.sh, which can be run manually and which will add a new item under "merged pull requests". That might be useful when merging a PR.I've also shortly experimented with generating the "Fixed issues" section - to generate a basic list is easy. But I guess, this needs to be updated manually.
Related issues
Ready?
./mvnw clean verifypasses (checked automatically by github actions)