JuliaRegistries / TagBot

Creates tags, releases, and changelogs for your Julia packages when they're registered
https://github.com/marketplace/actions/julia-tagbot
MIT License
94 stars 20 forks source link

PRs before issues in default changelog #219

Closed fonsp closed 1 year ago

fonsp commented 2 years ago

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.

DilumAluthge commented 2 years 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.

fonsp commented 2 years ago

@DilumAluthge sounds great! Are you talking about generate_release_notes in the release api or the unofficial gren?

DilumAluthge commented 2 years ago

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.

fonsp commented 2 years ago

@DilumAluthge I updated my comment above

IanButterworth commented 1 year ago

This sounds good to me as-is (pending working tests)