Releasing
Kact releases are prepared locally from main. make publish runs the release checks, creates the release commit and tag, and pushes both. GitHub Actions builds the archives and creates the GitHub Release.
Prepare a stable release
Section titled “Prepare a stable release”-
Start with an up-to-date, clean
mainbranch. -
Consolidate the user-visible changes since the last stable release under a new
## X.Y.Zheading inCHANGELOG.md.Include changes that previously appeared in release candidates so the stable GitHub Release stands on its own. Keep the earlier
-rc.Nsections as historical records. Leave a fresh, empty## Unreleasedheading above the new version. -
Set
[package].versioninCargo.tomlto the sameX.Y.Zvalue and updateCargo.lock. -
Review the release preparation:
Terminal window git diff --checkgit status --shortBefore publishing, only
Cargo.toml,Cargo.lock, andCHANGELOG.mdmay have changes. Commit or remove any unrelated work first. -
Publish:
Terminal window make publish
The command reads the version from Cargo.toml; do not pass a version argument. It runs linting, tests, documentation build, and host archive packaging, then creates chore: release vX.Y.Z, tags it, and pushes main with the tag.
Release candidates
Section titled “Release candidates”Use the same process with a prerelease version such as 0.1.0-rc.1 and a matching ## 0.1.0-rc.1 changelog section. GitHub publishes tags with a prerelease suffix as GitHub prereleases, so they do not replace the stable installer target.
When promoting an RC to X.Y.Z, make the stable changelog section cumulative: include every user-visible feature and fix delivered by the RC, plus any changes since it.
Verify the published release
Section titled “Verify the published release”After the GitHub Actions release workflow finishes:
-
Confirm its checks, three platform archives,
SHA256SUMS, and generated release notes on the GitHub Release page. -
Install into a temporary directory and check the version:
Terminal window test_dir=$(mktemp -d)curl --proto '=https' --tlsv1.2 -fsSL https://raw.githubusercontent.com/iamgideonidoko/kact/main/scripts/install.sh | KACT_INSTALL_DIR="$test_dir" bash"$test_dir/kact" --versionrm -rf "$test_dir"For a stable release, the command must install the new version without
--version. -
On macOS, run the installed binary through
kact setup, activate a grid, and verify pointer actions. On X11, verify a harmless shell action such askact move --dx 1.
If publishing fails
Section titled “If publishing fails”If local checks fail, fix the issue before rerunning make publish; it has not created a tag yet. If GitHub Actions fails after the tag is pushed, rerun the workflow only for an infrastructure failure. For a release defect, fix it and publish a new version. Do not move or reuse a published tag.