diff --git a/docs/website/docs/developers/general/release-promotion.png b/docs/website/docs/developers/general/release-latest.png similarity index 100% rename from docs/website/docs/developers/general/release-promotion.png rename to docs/website/docs/developers/general/release-latest.png diff --git a/docs/website/docs/developers/general/release-management.md b/docs/website/docs/developers/general/release-management.md index 0183da078829..89a3710e8a25 100644 --- a/docs/website/docs/developers/general/release-management.md +++ b/docs/website/docs/developers/general/release-management.md @@ -7,7 +7,7 @@ icon: octicons/package-16 IREE cuts automated releases via a workflow that is [triggered daily](https://github.com/iree-org/iree/blob/main/.github/workflows/schedule_candidate_release.yml). The only constraint placed on the commit that is released is that it has -[passed all required CI checks](https://github.com/iree-org/iree/blob/main/build_tools/scripts/get_latest_green.sh). +[passed certain CI checks](https://github.com/iree-org/iree/blob/main/build_tools/scripts/get_latest_green.sh). These are published on GitHub with the "pre-release" status. For debugging this process, see the [Release debugging playbook](../debugging/releases.md). @@ -38,7 +38,7 @@ contribute release notes on those issues. After approximately one month since the previous release, a new release should be promoted from nightly release candidates. -When selecting a candidate we use the following criteria: +When selecting a candidate we aim to meet the following criteria: 1. ⪆4 days old so that problems with it may have been spotted 2. Contains no P0 regressions vs the previous stable release @@ -56,9 +56,28 @@ request that some feature make the cut. * For Googlers, the password is stored at -2. Open the release on GitHub. Rename the release from "candidate" to "stable", - uncheck the option for "pre-release", and check the option for "latest". +2. Create a new release on GitHub: - ![rename_release](./release-renaming.png) + * Set the tag to be created and select a target commit. For example, if the + candidate release was tagged `iree-3.1.0rc20241119` at commit `3ed07da`, + set the new release tag `iree-3.1.0` and use the same commit. - ![promote_release](./release-promotion.png) + ![rename_tag](./release-tag.png) + + * Set the title to `Release vX.Y.Z`. + + * Paste the release notes from the release tracking issue. + + * Upload the `.whl` files produced by the `pypy_deploy.sh` script (look for + them in your `/tmp/` directory). These have the stable release versions + in them. + + * Download the `iree-dist-.*.tar.xz` files from the candidate release and + upload them to the new stable release. + + * Uncheck the option for "pre-release", and check the option for "latest". + + ![promote_release](./release-latest.png) + +3. Complete any remaining checkbox items on the release tracking issue then + close it and open a new one for the next release. diff --git a/docs/website/docs/developers/general/release-renaming.png b/docs/website/docs/developers/general/release-renaming.png deleted file mode 100644 index e8bc98fb8181..000000000000 Binary files a/docs/website/docs/developers/general/release-renaming.png and /dev/null differ diff --git a/docs/website/docs/developers/general/release-tag.png b/docs/website/docs/developers/general/release-tag.png new file mode 100644 index 000000000000..8f232d6fb964 Binary files /dev/null and b/docs/website/docs/developers/general/release-tag.png differ