feat: improve release note generation #65
Merged
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.
What this PR does / why we need it:
Improves the release note generation in the following ways:
#in front of PR numbers.NONEnow don't show up in the release notes anymore (this e.g. usually includes the release PRs).Which issue(s) this PR fixes:
Fixes openmcp-project/backlog#243
Special notes for your reviewer:
Disclaimer: I tested this locally, but there is not really a way to check whether it also works in the GHA until the PR is merged ...
Here is an example comparison between the old and the new generation logic. It is based on the diff between versions
v0.2.0andv0.3.0of the Gardener ClusterProvider, since the corresponding PRs contained an example with multiple release note blocks.The first example was generated with the old logic, the second one with the new logic. They are separated by horizontal lines to be distinguishable from the rest of the PR info.
Note that the old logic example actually contains an unclosed code block, which I had to close (by adding three backticks to the end of the release notes) to not mess up the formatting.
Changes included in v0.3.0:
🚀 Features
ClusterConfigresources.Changes included in v0.3.0:
🚀 Features
ClusterConfigresources.AccessRequestcontroller that could cause a panic when referencing aClusterresource that does not have a corresponding Gardener shoot.🔧 Chores
Release note: