VERSION contains MAJOR.MINOR.PATCH, without a leading v. The build generates the assembly version, file version, informational version, and manifest version from it. The UI reads the assembly version. Do not edit generated .build/ files.
-
Update
VERSIONand add an entry toCHANGELOG.md. -
Run
./scripts/Build.ps1,./scripts/Test.ps1, and./scripts/Package.ps1on Windows. Then run./scripts/Get-InstallerCompiler.ps1,./scripts/Build-Installer.ps1, and./scripts/Test-Installer.ps1. The compiler setup installs the pinned Inno compiler into.build; installer tests need internet and an account without an existing installed ClearFrame. -
Review the ZIP: it should contain the app, configuration, license, guide, installer and tool lock file; no third-party executables, media, history or credentials.
-
Commit the changes and push
main. Wait for CI to pass. -
Create an annotated tag matching the version, for example:
git tag -a v0.2.1 -m "ClearFrame 0.2.1" git push origin v0.2.1
-
The release workflow verifies the tag, builds and tests the application and installer, then publishes the ZIP, versioned setup executable, stable
ClearFrame-Setup.exealias and SHA-256 checksums on GitHub Releases. It uses only the workflow's short-lived GitHub token. Verify the stable latest-release download link after publication; this is the link users share.
The installer downloads third-party tools onto the destination PC from the same lock file as the portable setup script. Do not embed downloaded tool binaries in the setup without separately addressing their licenses. The installer owns its application/tool files and Windows uninstall record, but never registers user history or downloaded media for deletion. Its fixed AppId preserves upgrade identity; do not change it between releases. The app's mutex prevents updates while ClearFrame is open.
If a tag's release fails, fix the cause and inspect the run before retrying. Do not silently move a published tag. Tool lock updates should use versioned upstream URLs, never a mutable /latest/ asset; if an asset is removed, setup fails rather than substituting an unchecked version.
The ZIP's version is the application version. External tool versions are independent and tracked in config/tools.lock.json. The in-app engine-update button can change the installed yt-dlp version after setup.