[FEA]: Automate generating release notes structured based on required PR labels #3191
Open
1 of 4 tasks
Labels
feature request
New feature or request.
Is this a duplicate?
Area
Infrastructure
Is your feature request related to a problem? Please describe.
As a user and consumer of CCCL, I would like CCCL's release notes to be structured to help me find updates that are relevant to me.
I would like to make it part of CCCL's release automation to auto-generate structured release notes based on labels required to be applied to PRs before they can be merged.
For example, in RAPIDS repos their release notes are auto-generated in the following structure:
Furthermore, part of their CI status check requires one of these labels be set in order to merge. This prevents accidentally merging a PR without one of these required labels and ensuring our release notes are comprehensive.
In RAPIDS they had to implement this logic themselves, but it looks like this functionality is built directly into GitHub now which should make it even easier.
As far as I can tell, the built-in functionality only solves generating the release notes based on labels. It doesn't do anything to require PRs have a label to be merged. So we'd still need to add that as our own workflow for the CI status check.
RAPIDS implementation of the label checker is unique to the fact that they don't use GitHub's native UI for merging PRs and instead uses a bot with triggered by a
/merge
command. Triggering the merge command will check for the required labels and fail if not present.I had been thinking of instead implementing this as a workflow and making it required for the status check.
Describe the solution you'd like
.github/release.yml
file for auto-structured release notesDescribe alternatives you've considered
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: