Skip to content
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

Merged
merged 3 commits into from
Sep 11, 2023

Conversation

fonsp
Copy link
Contributor

@fonsp fonsp commented Nov 23, 2021

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
Copy link
Member

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
Copy link
Contributor Author

fonsp commented Nov 23, 2021

@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 More accurate release notes for backport releases #181 !

@DilumAluthge
Copy link
Member

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
Copy link
Contributor Author

fonsp commented Nov 23, 2021

@DilumAluthge I updated my comment above

@IanButterworth
Copy link
Member

IanButterworth commented Aug 25, 2023

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

Copy link
Member

@IanButterworth IanButterworth left a 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

@IanButterworth IanButterworth merged commit 4a27437 into JuliaRegistries:master Sep 11, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants