Closed fonsp closed 1 year ago
Alternatively, we could switch to using GitHub's new API for generating release notes, which only includes PRs. Personally I find the list of PRs to be sufficient.
@DilumAluthge sounds great! Are you talking about generate_release_notes
in the release api or the unofficial gren
?
It looks like gren
only considers issues, not PRs, but uses the bug
or enhancement
label to filter them. (Example output) This filtering would also solve my problem with listing all the closed issues!
For generate_release_notes
, I ran it on a recent Pluto release to see what it looks like: this is the default output of TagBot, and this is the default output of generate_release_notes
. It looks like this solves #181 !
The official API: https://docs.github.com/en/rest/reference/repos#generate-release-notes-content-for-a-release
Looks like they give you back the release notes as a Markdown-formatted string.
@DilumAluthge I updated my comment above
This sounds good to me as-is (pending working tests)
Just a small, opinionated PR: I found the list of merged PRs much more descriptive of the changes than the list of closed issues.
I notice this most when we closed issues without solving them, e.g. duplicates, outdated, etc. But the titles still show up in our changelog, giving the impression that they were 'solved'.
Feel free to close without discussion 🌟 it's already cool that I can use this as my custom changelog template on my own repos.