-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
PRs before issues in default changelog #219
Conversation
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
|
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@christopher-dG this seems like a good idea to me. I've independently thought it prior to this
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.