[github automatic releases] use github's "Auto-generate release notes" feature
DetachHead opened this issue · 7 comments
Yes please ;)
Hey there! The GitHub release notes feature looks pretty cool! I am not sure how the automatic-releases action would help with it though?
If the GH release notes feature works for you, why would you still use the automatic-releases action?
From my understanding, it doesn't automate releases like this action does, it only generates the release notes. I'd imagine the automatic-releases action is still needed to actually create them
@DetachHead Ahh, I gotcha. I'll consider it, and keep this open for now 👍🏾
Yeah, you will have to manually go in and click "create release", then select tag etc, and click the "auto-generate release notes" and click publish. So would be nice if this action could also optionally execute this command somehow :)
I would also like to see this feature soon!
Some additional information:
Docs can be found here.
For now I didn't find any official api for this.
For example when you edit the release with tag v0.0.1 and press the button a request to
https://github.com/:user:/:repo:/releases/notes?commitish=v0.0.1&tag_name=v0.0.1
is executed and returns a json containing the generated release notes as markdown.
I wonder if you could try query this endpoint.
@marvinpinto
I think the REST API from GitHub now supports this feature:
https://docs.github.com/en/rest/reference/releases#create-a-release
see parameter generate_release_notes
Whether to automatically generate the name and body for this release. If name is specified, the specified name will be used; otherwise, a name will be automatically generated. If body is specified, the body will be pre-pended to the automatically generated notes.
Default: false
I'm not into js development, but should be quite easy to pass this parameter?
Would be nice if somebody can pick this up - otherwise I'll try my luck in the next couple of weeks.