[Release]: Release checklist for v0.5.0rc1

[yuanzhg078]

Release Checklist

Release Version: v0.5.0rc1
Release Branch: release
Release Date: 2026/4/1
Release Manager: @yuanzhg078

Functional Test

Please test the functionality before you publish a release

• Offline inference
• Online inference

Optional: Doc Test

• User Guide is updated.

Prepare release tag

Make sure

• Create a PR that update package version in setup.py to 0.5.0rc1, for example 👉
• Merge develop branch to release branch and main branch, ask 👉 @mag1c-h for help
• Create release tag based on release branch

(On branch release)
# create a tag locally
git tag v0.5.0rc1

# push to remote
git push origin v0.5.0rc1

if anything goes wrong, revert by

# delete a tag locally
git tag -d v0.5.0rc1

# delete from remote
git push origin -d v0.5.0rc1 -f

Prepare Release Content

• Create a release draft and prepare the release note 👉 here, choose the tag you just created

Prepare Artifacts

In this step, you will create two artifacts, one is a source distribution package which will be uploaded to pypi, another is a docker image and which will be pushed to dockerhub.

Create and upload can be easily done with script 👉publish.sh, ask @Lijiachen1018 for credentials.

Put the script in root directory of unified-cache-management, and follow the guide below

# Usage: 
#       
# set environment variables: TAG_NAME, GITHUB_TOKEN, PYPI_API_TOKEN, HTTP_PROXY, HTTPS_PROXY, etc.
# export PYPI_API_TOKEN="your_pypi_token"
# export PYPI_REPO="testpypi or pypi"
# export HTTP_PROXY="http://proxy:port"
# export HTTPS_PROXY="http://proxy:port"
# export DOCKER_USERNAME="your_username, eg. unifiedcachemanagement"
# export DOCKER_PASSWORD="your_password, dockerhub token created in first step"
# export DOCKER_HUB_REPO="your_dockerhub_repo_name, eg. unifiedcachemanagement/ucm"
# export GITHUB_USERNAME="your_github_username"

# Login to dockerhub with your credentials
#       docker login
#
# Finally create a release with the tag name
#       ./publish.sh [TAG_NAME]

Check

• Docker image is ready on dockerhub
• Source distribution package is ready on Pypi

Release Step

• Release note PR is merged.
• Post the release on GitHub release page.
• Check Artifacts
• Broadcast the release news (By message, blog , etc)
• Close this issue

Prepare Release Note

• Create a new issue for release feedback

• Write the release note PR.

  • Update the feedback issue link in docs/source/faqs.md

  • Add release note to docs/source/user_guide/release_notes.md

  • Update version info in docs/source/community/versioning_policy.md

  • Update contributor info in docs/source/community/contributors.md

  • Update package version in docs/conf.py

PR need Merge

Functional Test

• Test by ci

Doc Test

• Tutorial is updated.
• User Guide is updated.
• Developer Guide is updated.

Prepare Artifacts

• Docker image is ready.
• Wheel package is ready.

Release Step

• Release note PR is merged.
• Post the release on GitHub release page.
• Generate official doc page on https://ucm.readthedocs.io/en
• Broadcast the release news (By message, blog , etc)
• Close this issue