Replace drafter workflow with github's simple generator config #2887
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
This commit replaces the slightly overcomplicated release-drafter workflow with a simple configuration that will let GitHub's own release note generator categorize PRs. GitHub generator doesn't allow to define an overall template for the notes, nor does it allow customization of how each PR entry looks like. That said, it is good enough in most cases and seems to deal correctly with multiple release branches (when fetching and comparing against the latest tag, it filters on the specified target branch for the release draft). The old workflow was more configurable, but also relying on more moving pieces: - a specific Gradle task to compute the latest tag - the changelog generating action with non-default fromTag and toTag configuration - an action requiring a large scope (contents:write) just to be able to produce a drafted release This solution is more limited, but also easier to reason about in terms of security.
simonbasle
added
the
type/chores
violetagg
approved these changes
Jan 13, 2022
ghost
mentioned this pull request
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.
This commit replaces the slightly overcomplicated release-drafter
workflow with a simple configuration that will let GitHub's own release
note generator categorize PRs.
GitHub generator doesn't allow to define an overall template for the
notes, nor does it allow customization of how each PR entry looks like.
That said, it is good enough in most cases and seems to deal correctly
with multiple release branches (when fetching and comparing against the
latest tag, it filters on the specified target branch for the release
draft).
The old workflow was more configurable, but also relying on more moving
pieces:
configuration
produce a drafted release
This solution is more limited, but also easier to reason about in terms
of security.