Wasmtime GitHub notifications bot (May 22 2024 at 18:43): Wasmtime GitHub notifications bot (May 22 2024 at 18:43):alexcrichton opened PR #8680 from alexcrichton:new-relnotes to bytecodealliance:main:
This commit updates how Wasmtime manages release notes across released versions of Wasmtime. One of the most onerous parts about releases right now is writing release notes in all the locations and making sure they're all up-to-date and in-sync. This is inevitably forgotten in some cases and various pieces will slip through the cracks. The basic idea of this PR is to change our release notes to only document the release branch that they're on. All historical release notes are relegated to historical branches.
With this change there's no longer any need to backport or forward-port release notes for any changes. Instead release notes are written once on one branch and that's it.
The major downside of this change is that there's no easy way to get a bird's eye view of all release notes for Wasmtime any more. If necessary that could theoretically be automated in the future (like https://releases.rs/), but for now this feels like an acceptable compromise to make releases much easier.
The contents of this PR are to update
RELEASES.mdwith back-links to historical release notes as well as the various pieces of automation we have about managing release notes.<!--
Please make sure you include the following information:
If this work has been discussed elsewhere, please include a link to that
conversation. If it was discussed in an issue, just mention "issue #...".Explain why this change is needed. If the details are in an issue already,
this can be brief.Our development process is documented in the Wasmtime book:
https://docs.wasmtime.dev/contributing-development-process.htmlPlease ensure all communication follows the code of conduct:
https://github.com/bytecodealliance/wasmtime/blob/main/CODE_OF_CONDUCT.md
-->
Wasmtime GitHub notifications bot (May 22 2024 at 18:43):alexcrichton requested wasmtime-default-reviewers for a review on PR #8680.
Wasmtime GitHub notifications bot (May 22 2024 at 18:43):alexcrichton requested cfallin for a review on PR #8680.
Wasmtime GitHub notifications bot (May 22 2024 at 18:47):alexcrichton updated PR #8680.
Wasmtime GitHub notifications bot (May 22 2024 at 19:34):cfallin submitted PR review:
This seems reasonable, with one question below about point-releases. Thanks!
Wasmtime GitHub notifications bot (May 22 2024 at 19:34):cfallin submitted PR review:
This seems reasonable, with one question below about point-releases. Thanks!
Wasmtime GitHub notifications bot (May 22 2024 at 19:34):cfallin created PR review comment:
s/currnet/current/
Wasmtime GitHub notifications bot (May 22 2024 at 19:34):cfallin created PR review comment:
I think we don't need to include point-releases, since there is no separate branch to link to (and the
release-X.0.0branch will contain all updates fromX.Y.Z); but should we note somewhere, e.g. list the point-releases here in the link text or after the link?Otherwise I could imagine some confusion: I'm curious what was released in 21.0.1, I look at this list, I don't see the version number and get confused (or grep for it, same result).
Wasmtime GitHub notifications bot (May 22 2024 at 19:39):cfallin submitted PR review.
Wasmtime GitHub notifications bot (May 22 2024 at 19:39):cfallin created PR review comment:
Alternately: name the link text something like "21.x releases" or "21.0.0 and following" or ...
Wasmtime GitHub notifications bot (May 22 2024 at 19:53):alexcrichton submitted PR review.
Wasmtime GitHub notifications bot (May 22 2024 at 19:53):alexcrichton created PR review comment:
I actually originally had this written here as 21.0.x but I ended up renaming since it was nontrivial to create the string "21.0.x" from the string "21.0.0" available in the release scripts in github actions. I think you're right though, I'll try to switch this to "21.0.x" (along with everything below), to make it more clear that it's for all those releases.
Wasmtime GitHub notifications bot (May 22 2024 at 19:55):alexcrichton submitted PR review.
Wasmtime GitHub notifications bot (May 22 2024 at 19:55):alexcrichton created PR review comment:
I also regret choosing the release branch name as
release-N.0.0originally since that'd be more appropriate asrelease-N.0.xas well...
Wasmtime GitHub notifications bot (May 22 2024 at 19:56):alexcrichton updated PR #8680.
Wasmtime GitHub notifications bot (May 23 2024 at 16:50):alexcrichton merged PR #8680.
Last updated: Nov 22 2024 at 16:03 UTC