wgpu/docs/release-checklist.md

This is an overview of how to run wgpu releases.

Structure

We do a major breaking release every 12 weeks. This happens no matter the status of various in-flight projects.

We do a patch releases as needed in the weeks between major releases. Once a new major release is cut, we stop doing patch releases for the previous major release unless there is a critical bug or a compilation issue.

People

Anyone in the @gfx-rs/wgpu team can perform these steps.

Major Release Process

Approx 1 Week Before:

• Determine if glow (@groves), metal-rs (@gfx-rs/wgpu) or any other dependant crates will need a release. If so, coordinate with their maintainers.
• Go through the changelog:
  • Re-categorize miscategorized items.
  • Edit major changes so a user can easily understand what they need to do.
  • Add missing major changes that users need to know about.
  • Copy-edit the changelog for clarity.

Day of Release:

• Update the version number in the root Cargo.toml to the new version, this will update all crates to the new version.
• Bump the wgpu dependency numbers in the following places:
  • Cargo.toml
  • examples/standalone/*
• Grep for the previous version to ensure various documentation links are updated.
  • For example, if the previous version was v24.0.0, grep for v24 and 24.0
• Ensure glow and metal are updated to the latest version if needed.
• Add a new header for the changelog with the release version and date.
• Create a PR with all of the version changes and changelog updates.
• Once the PR is CI clean, (force) merge it.
• Checkout trunk with the merged PR.
• Publish! These commands can be pasted directly into your terminal in a single command, and they will publish everything.

    cargo +stable publish --workspace --exclude deno_webgpu
  

• If there were any newly published crates, ensure github:gfx-rs/wgpu is added as an owner of that crate.
• Create a new tag called vX.Y.Z and push it to the repo.
  • For each crate being released (viz., every publish-able crate that is not deno*), create a new tag of the form {crate_name}-vX.Y.X.
• Create a new release on the wgpu repo with the changelog from this version, targeting that tag
• Create a branch with the with the new version vX and push it to the repo.
  • On this branch, remove the [!NOTE] at the top of [wgpu/examples/README.md].
• Complete the release's milestone on GitHub.
• Create a new milestone for the next release, in 12 weeks time.
• Update the release checklist with any needed changes.
• Publish the link to the github release in the following places.
  • r/rust.
    • Add an AMA comment.
  • Crosspost to r/rust_gamedev.
    • Add an AMA comment.
  • Include the r/rust post shortlink in the following posts as well:
  • wgpu matrix
  • Rust Gamedev Discord in the #crates channel
  • Bevy Discord in the #rendering-dev channel
  • Graphics Programming Discord in the #webgpu channel
  • Rust Community Discord in the #games-and-graphics channel

Patch Release Process

• Enumerate all PRs that haven't been backported yet. These use the PR: needs back-porting label. GH Link
• On your own branch based on the latest release branch. Cherry-pick the PRs that need to be backported. When modifying the commits, use --append to retain their original authorship.
• Remove the needs-backport label from the PRs.
• Fix the changelogs items and add a new header for the patch release with the release version and date.
  • The release section should start with a header saying the following (for example)

    This release includes `crate1`, `crate2` and `crate3` version `X.Y.Z`. All other crates remain at their previous versions.
    

• Once all the PRs are cherry-picked, look at the diff between HEAD and the previous patch release. See what crates changed.
• Bump all the versions of the crates that changed.
• Create a PR with all of the version changes and changelog updates into the release branch.
• Once the PR is CI clean, (force) rebase merge it.
• Checkout the release branch with the merged PR.
• Publish all relevant crates (see list above).
• Create a new release on the wgpu repo with the relevant changelog included, based on a new tag called vX.Y.Z in the release branch.
  • For each crate released, also create a tag {crate_name}-vX.Y.Z.
• Backport the changelog and version bumps to the trunk branch.
  • Ensure that any items in the newly-released changelog don't appear in the "unreleased" section of the trunk changelog.
• Update the release checklist with any needed changes.