Add Release Drafter to draft releases #5058
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.
I've not been updating CHANGES.rst for a while partly because it became too big/unwieldy to be editable on mobile. Also it's the sort of manual work that could and should be automated.
Let's automate it!
Release Drafter is a GitHub Action which runs when PRs are merged and I've been happily using it on other projects.
It takes the titles of PRs merged since the last release, and puts them into a draft release at https://github.com/python-pillow/pillow/releases
Drafts are only visible to maintainers, until they're published.
The idea is the draft will fill up, then on release day, the draft is published as usual.
If we still value putting the list into
CHANGES.rst
(do we?), we can copy and paste it during the release process (which includes updatingCHANGES.rst
anyway).PRs labelled with
changelog: skip
are excluded.If we want, we can further configure it to automatically put PRs into groups based on labels. Here's a good example:
I suggest running just with the basic config to begin, and consider categories later, although suggestions welcome!
The draft is updated each time the action runs, so any final touches should be made just before publishing. Or better: update the PR titles themselves, which is a good idea for future SEO.