Skip to content

Release Checklist

Jump to bottom
Joe edited this page Jun 8, 2026 · 1 revision

Release Checklist

Use this checklist when preparing a tagged release.

Before Tagging

  1. Confirm version numbers are in sync:

    pyproject.toml
src/imvu_toolkit/__init__.py
CHANGELOG.md

  2. Move user-visible notes from [Unreleased] into the new version section in CHANGELOG.md.

  3. Run local checks:

    python -m pip install -e ".[dev]"
ruff check src tests
pytest

  4. Build the installer locally if Windows is available:

    python -m pip install -e ".[build]"
.\build_installer.ps1

  5. Smoke-test install and restore on a disposable IMVU Classic setup if the patch behavior changed.

Tag

git tag vX.Y.Z
git push origin vX.Y.Z

Use the real release version in the tag. Pushing a v* tag runs the GitHub Actions release workflow.

GitHub Actions Release Flow

The release workflow:

  1. Checks out the repo on windows-latest.
  2. Installs build dependencies.
  3. Runs build_installer.ps1.
  4. Extracts release notes from CHANGELOG.md.
  5. Appends the SHA256 hash and VirusTotal link.
  6. Publishes dist/IMVU-Emoji-Installer.exe to GitHub Releases.

After Release

  • Confirm the release asset is present.
  • Confirm the SHA256 in release notes matches the uploaded .exe.
  • Download the release asset and verify the GUI launches.
  • Submit the .exe to Microsoft Defender as a false positive if needed.
  • Update this wiki if install, restore, or troubleshooting steps changed.

PowerShell hash check:

Get-FileHash .\IMVU-Emoji-Installer.exe -Algorithm SHA256

Related Docs

Clone this wiki locally