From 45eac5a8ff513718f81566eb68fe7cbd8a77fbd8 Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Wed, 5 Feb 2025 13:47:13 -0800 Subject: [PATCH] Document patch release process This didn't really exist before but it basically now does, so document this so others can follow it in the future. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index da0ae828ef..4fc4d41f63 100644 --- a/README.md +++ b/README.md @@ -293,6 +293,30 @@ For maintainers, the release process looks like: That should be it, but be sure to keep an eye on CI in case anything goes wrong. +## Patch Release Process + +Patch releases aren't too frequent so the process is a bit more involved at this +time. The basic idea is the same though as a normal release: + +* Determine that you're going to make a patch release for the release of + `wasm-tools` version `1.N.0`. +* If `N` is the latest version on `main`, or basically if a major release hasn't + happened since `N`, then land changes on `main` first. Then go to [this + link](https://github.com/bytecodealliance/wasm-tools/actions/workflows/release-process.yml) + and run the workflow against the `main` branch with `bump-patch` as an + argument. Double-check all changes from the `v1.N.0` tag to ensure that no + breaking changes in any crate have landed. +* If `N` is not the latest version on `main`, then create a new branch in the + repository named `release-N` starting from the `v1.N.0` tag. Next land changes + as PRs against this branch, and note that CI may not have been run in awhile + so it may need some fixes. Then run the same workflow as above against the + `release-N` branch with the `bump-patch` argument. Again double-check that no + breaking changes have been made. + +Basically a `release-N` may need to be manually created if the `main` branch has +moved beyond `N`. After that though it should work basically the same where a +workflow is run and a PR is merged and that's all that's necessary. + # Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about contributing