Consider auto-generated changelog #157
Replies: 5 comments 2 replies
-
https://docs.github.com/en/rest/reference/repos#generate-release-notes-content-for-a-release is the REST API for getting the generated release notes. Looks like it would be easiest to get the release tagged, then generate the release notes, then update the release with those notes. |
Beta Was this translation helpful? Give feedback.
-
Will also have to decide whether to keep |
Beta Was this translation helpful? Give feedback.
-
cli/cli#4466 is tracking adding this to |
Beta Was this translation helpful? Give feedback.
-
I've used https://github.com/marketplace/actions/release-drafter for this in some of my projects, it takes a small amount of configuring so you can get the format/labels how you like it etc. but once it's set up it truly is a "fire and forget" type thing, just reliably produces nice release notes with every tag! My only potential gripe is that I end up manually copying and pasting the notes from the "Draft" to the actual release text, I'm sure it's possible to automate this with some API calls but I haven't got around to it yet! I've not tried the GitHub built in versions yet so I can't offer any kind of comparison |
Beta Was this translation helpful? Give feedback.
-
Tracking in #179 . |
Beta Was this translation helpful? Give feedback.
-
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
Not sure if it's worth it to drop scriv, but it may make PRs easier from external contributors as there is less of a chance of someone forgetting a news file.
Beta Was this translation helpful? Give feedback.
All reactions