Skip to content

Commit

Permalink
Document patch release process (#2041)
Browse files Browse the repository at this point in the history
This didn't really exist before but it basically now does, so document
this so others can follow it in the future.
  • Loading branch information
alexcrichton authored Feb 5, 2025
1 parent c09f2af commit 59b0020
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 59b0020

Please sign in to comment.