Provide release details in GitHub Releases #7068
Comments
|
I agree! The best thing to do here would probably be to copy the release notes that you've linked to the release itself, ideally automatically. Fiddling with the release process is pretty difficult though since it's difficult to test, and I suspect this'll require some well-crafted shell commands and such to get right which I'm not myself 100% sure of. |
|
Maybe in the meantime having a single link to release file is a good middle ground? |
|
I agree, it's somewhat hard to follow today. For example, this screenshot shows two releases, with no changes in either of them. Doesn't make any sense to me.
Github has built-in support for auto-generating release notes, based on the labels of all associated PRs. It's a pretty easy way of getting good release notes with simple grouping (features, internal, bug fixes, cleanups, documentation, etc). Looks like this: https://github.com/github/issue-metrics/releases |
|
Rust has a bot which copies the release notes from RELEASES.md into github releases I believe. Maybe the same could be done for Wasmtime? |
|
You wouldn't happen to have a link on-hand to how this is integrated in to rust-lang/rust, would you? I'm not sure how to configure this all myself. |
|
Seems to be part of triagebot: https://github.com/rust-lang/triagebot/tree/master/src/changelogs Should be possible to port it to github actions though. |
This commit is an attempt to tackle bytecodealliance#7068 by configuring the release notes in Github Releases with the handwritten release notes from `RELEASES.md`. The basic idea here is to split the markdown file on `-----` delimiters and then find the one which matches the version being released. Once one is found the `body` field of the API call to create the release is configured. This is unfortunately quite difficult to test, so I haven't actually tested it. I'm hoping this won't at least halt the release so we can see how it goes for the next one and fix any issues that arise.
This commit is an attempt to tackle bytecodealliance#7068 by configuring the release notes in Github Releases with the handwritten release notes from `RELEASES.md`. The basic idea here is to split the markdown file on `-----` delimiters and then find the one which matches the version being released. Once one is found the `body` field of the API call to create the release is configured.
|
Ok I think this will be fixed by #7405 |
* Attempt to automatically configure release notes This commit is an attempt to tackle #7068 by configuring the release notes in Github Releases with the handwritten release notes from `RELEASES.md`. The basic idea here is to split the markdown file on `-----` delimiters and then find the one which matches the version being released. Once one is found the `body` field of the API call to create the release is configured. * Update .github/actions/github-release/main.js Co-authored-by: Andrew Brown <andrew.brown@intel.com> --------- Co-authored-by: Andrew Brown <andrew.brown@intel.com>
* Attempt to automatically configure release notes This commit is an attempt to tackle bytecodealliance#7068 by configuring the release notes in Github Releases with the handwritten release notes from `RELEASES.md`. The basic idea here is to split the markdown file on `-----` delimiters and then find the one which matches the version being released. Once one is found the `body` field of the API call to create the release is configured. * Update .github/actions/github-release/main.js Co-authored-by: Andrew Brown <andrew.brown@intel.com> --------- Co-authored-by: Andrew Brown <andrew.brown@intel.com>
* Attempt to automatically configure release notes This commit is an attempt to tackle #7068 by configuring the release notes in Github Releases with the handwritten release notes from `RELEASES.md`. The basic idea here is to split the markdown file on `-----` delimiters and then find the one which matches the version being released. Once one is found the `body` field of the API call to create the release is configured. * Update .github/actions/github-release/main.js --------- Co-authored-by: Andrew Brown <andrew.brown@intel.com>
and others
When you look at https://github.com/bytecodealliance/wasmtime/releases/tag/v13.0.0 there's no information about what is in the release (and subscribing to GitHub release notifications means releases are, at least for me, the primary way to find out about new releases). You have to navigate to https://github.com/bytecodealliance/wasmtime/blob/main/RELEASES.md#1300 in order to find out what's contained in the release.
Any way to either inline the release notes into the GitHub release or at least provide a link to the document?
The text was updated successfully, but these errors were encountered: