Configure GitHub's release notes autogeneration #1450
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.
As it turns out, GitHub has some optionality for how it auto generates release notes.
This is an initial attempt towards using it.
It means we'll need to be a little more dedicated about labels (at least the ones that configure release notes). But we can evolve that. Or even lint it. I'm not totally sure of the categories yet. These are roughly the ones we've used in the past.
I'm also not sure if the
label: "*"
can be in the middle there, or if we'll need to think harder. But it seems like an easy thing to try.