Skip to content

Commit 59b0020

Browse files
authored
Document patch release process (#2041)
This didn't really exist before but it basically now does, so document this so others can follow it in the future.
1 parent c09f2af commit 59b0020

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,30 @@ For maintainers, the release process looks like:
293293

294294
That should be it, but be sure to keep an eye on CI in case anything goes wrong.
295295

296+
## Patch Release Process
297+
298+
Patch releases aren't too frequent so the process is a bit more involved at this
299+
time. The basic idea is the same though as a normal release:
300+
301+
* Determine that you're going to make a patch release for the release of
302+
`wasm-tools` version `1.N.0`.
303+
* If `N` is the latest version on `main`, or basically if a major release hasn't
304+
happened since `N`, then land changes on `main` first. Then go to [this
305+
link](https://github.com/bytecodealliance/wasm-tools/actions/workflows/release-process.yml)
306+
and run the workflow against the `main` branch with `bump-patch` as an
307+
argument. Double-check all changes from the `v1.N.0` tag to ensure that no
308+
breaking changes in any crate have landed.
309+
* If `N` is not the latest version on `main`, then create a new branch in the
310+
repository named `release-N` starting from the `v1.N.0` tag. Next land changes
311+
as PRs against this branch, and note that CI may not have been run in awhile
312+
so it may need some fixes. Then run the same workflow as above against the
313+
`release-N` branch with the `bump-patch` argument. Again double-check that no
314+
breaking changes have been made.
315+
316+
Basically a `release-N` may need to be manually created if the `main` branch has
317+
moved beyond `N`. After that though it should work basically the same where a
318+
workflow is run and a PR is merged and that's all that's necessary.
319+
296320
# Contributing
297321

298322
See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about contributing

0 commit comments

Comments
 (0)