T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify patch release criteria (#3940)

Browse Source 
In today's Wasmtime meeting we discussed the acceptance criteria for
patch releases for Wasmtime and Cranelift. The criteria we came up with
were:

* Cranelift will get a patch release for any miscompilation, whether or
  not it affects Wasmtime.
* Wasmtime will get a patch release for security issues and bugs which
  seriously hinder usability.

The consensus at the time was that due to Wasmtime's monthly release
schedule we want to be pretty strict about what generates a patch
release, hence the threshold being at serious bugs as opposed to any
bugs found.

This commit attempts to update the `stability-release.md` document with
our documented release process. The release cadence section is brought
up to date, the Wasmtime section was edited slightly (it largely already
said this which I only just realized), and a Cranelift section was
added.
This commit is contained in:
Alex Crichton
2022-03-18 09:09:50 -05:00
committed by GitHub
parent 520ccc9215
commit 5f53fd5ca2
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/stability-release.md
View File

@@ -10,8 +10,9 @@ The high-level summary of Wasmtime's release process is:
Once a month Wasmtime will issue a new major version. This will be issued with a Once a month Wasmtime will issue a new major version. This will be issued with a
semver-major version update, such as 4.0.0 to 5.0.0. The precise schedule of semver-major version update, such as 4.0.0 to 5.0.0. The precise schedule of
Wasmtime's release may fluctuate slightly depending on public holidays and Wasmtime's release is currently an automated PR is sent to bump the version on
availability of release resources, but the general cadence will be once-a-month. the 5th of every month and a release is made when the PR is merged. The PR
typically gets merged within a few days.
Each major release of Wasmtime reserves the right to break both behavior and API Each major release of Wasmtime reserves the right to break both behavior and API
backwards-compatibility. This is not expected to happen frequently, however, and backwards-compatibility. This is not expected to happen frequently, however, and
@@ -27,11 +28,17 @@ any breaking change will follow these criteria:
feedback about embeddings. Release notes will clearly indicate if any major feedback about embeddings. Release notes will clearly indicate if any major
breaking changes through accepted RFCs are included in a release. breaking changes through accepted RFCs are included in a release.
Patch releases of Wasmtime will only be issued for security and correctness Patch releases of Wasmtime will only be issued for security and critical
issues for on-by-default behavior in the previous releases. If Wasmtime is correctness issues for on-by-default behavior in the previous releases. If
currently at version 5.0.0 then 5.0.1 and 4.0.1 will be issued as patch releases Wasmtime is currently at version 5.0.0 then 5.0.1 and 4.0.1 will be issued as
if a bug is found. Patch releases are guaranteed to maintain API and behavior patch releases if a bug is found. Patch releases are guaranteed to maintain API
backwards-compatibility and are intended to be trivial for users to upgrade to. and behavior backwards-compatibility and are intended to be trivial for users to
upgrade to.
Patch releases for Cranelift will be made for any miscompilations found by
Cranelift, even those that Wasmtime itself may not exercise. Due to the current
release process a patch release for Cranelift will issue a patch release for
Wasmtime as well.
## What's released? ## What's released?