Skip to content

Release managementlink

IREE cuts automated releases via a workflow that is triggered daily. The only constraint placed on the commit that is released is that it has passed certain CI checks. These are published on GitHub with the "pre-release" status. For debugging this process, see the Release debugging playbook.

We periodically promote one of these candidates to a "stable" release by removing the "pre-release" status. This makes it show up as a "latest" release on GitHub. We also push the Python packages for this release to PyPI.

All stable (non-prerelease) releases can be viewed at https://github.com/iree-org/iree/releases?q=prerelease%3Afalse.

Release statuslink

Package Release status
GitHub release (stable) GitHub Release
GitHub release (nightly) GitHub Release
Python iree-base-compiler PyPI version
Python iree-base-runtime PyPI version
Python iree-compiler (deprecated) PyPI version
Python iree-runtime (deprecated) PyPI version

Running a releaselink

A pinned issue tracking the next release should be filed like https://github.com/iree-org/iree/issues/18380. Developers authoring patches that include major or breaking changes should coordinate merge timing and contribute release notes on those issues.

Picking a candidate to promotelink

After approximately one month since the previous release, a new release should be promoted from nightly release candidates.

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
  3. LLVM submodule commit ideally exists upstream (no cherry picks or patches)
  4. Includes packages for all platforms, including macOS and Windows

When you've identified a potential candidate, comment on the tracking issue with the proposal and solicit feedback. People may point out known regressions or request that some feature make the cut.

Promoting a candidate to stablelink

  1. (Authorized users only) Push to PyPI using pypi_deploy.sh

  2. Create a new release on GitHub:

    • 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.

      rename_tag

    • 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

  3. Complete any remaining checkbox items on the release tracking issue then close it and open a new one for the next release.

Creating a patch releaselink

  1. Create a new branch.

    Checkout the corresponding stable release and create a branch for the patch release:

    git checkout iree-3.0.0
git checkout -b iree-3.0.1

  2. Apply and commit the patches.

  3. Set the patch level:

    • Adjust compiler/version.json if patches are applied to the compiler.

    • Adjust runtime/version.json if patches are applied to the runtime.

  4. Push all changes to the new branch.

  5. Trigger the Oneshot candidate release workflow to create a release.

    • Select to run the workflow from the patch branch.

    • Set the type of build version to produce to "stable".

      one_shot_patch

  6. Follow the documentation above to promote to stable. The step to create a new tag can be skipped.