mirror of
https://github.com/SerTimBerrners-Lee/talkis.git
synced 2026-07-09 17:29:15 +00:00
3.1 KiB
3.1 KiB
Release Rule
This file defines the mandatory release workflow for Talkis. Follow it for every release without skipping steps.
Naming
- Release branch:
release/vX.Y.Z - Release review file:
docs/release/review-vX.Y.Z.md - Git tag:
vX.Y.Z
Mandatory sequence
- Collect all local changes and push them to the release branch first.
- Update version numbers consistently in:
package.jsonsrc-tauri/Cargo.tomlsrc-tauri/tauri.conf.json
- Refresh
README.mdbefore every release so the documented behavior, supported platforms, commands, and release notes are current. - Run the release checks locally:
bun run check:releaseTAURI_SIGNING_PRIVATE_KEY_PATH=~/.tauri/talkis-updater.key bun run build:release:macos- On native Windows/Linux runners, run
bun run build:release:windowsandbun run build:release:linuxbefore claiming those artifacts are ready. - If the updater private key is password-protected, also set
TAURI_SIGNING_PRIVATE_KEY_PASSWORD.
- Perform a detailed self-review of the full release diff.
- Write the review results to
docs/release/review-vX.Y.Z.mdusing the review template. - If there are blockers, risks, or recommendations that need a decision, ask the user before merging to
main. - Only after review is complete and questions are resolved, merge or push the approved changes to
main. - Create and push the release tag
vX.Y.Zfrommain. - Let GitHub Actions build and publish the release for all currently supported release platforms.
Review checklist
- Working tree is clean and the release branch diff is intentional.
- README reflects the current product behavior and release process.
- Hotkey flow works, including capture, apply-without-restart, and onboarding interactions.
- Widget position, notices, and onboarding permissions behave correctly.
- Short or noisy recordings do not paste obvious hallucinated text.
bun run check:releasepasses.- Local production build passes via
bun run build:release:macos; Windows/Linux production builds pass on their native runners or in GitHub Actions. - Version numbers and release tag match.
- The GitHub Actions release workflow still matches the documented process.
- GitHub repository secrets include
TAURI_SIGNING_PRIVATE_KEYand, if the key is password-protected,TAURI_SIGNING_PRIVATE_KEY_PASSWORD. - GitHub Release includes
latest.json, macOS.app.tar.gz, Windows.exe, Linux.AppImage, and matching.sigfiles.
GitHub Actions release source of truth
- Workflow file:
.github/workflows/release.yml - Tag push is the canonical release trigger.
- The updater metadata endpoint is
https://github.com/SerTimBerrners-Lee/talkis/releases/latest/download/latest.json. - Build all platforms that are actually ready in the workflow. Do not claim unsupported platforms in release notes.
Output expectations
For each release, produce:
- release branch
release/vX.Y.Z - review file
docs/release/review-vX.Y.Z.md - updated
README.md - updated version files
- pushed
main - pushed tag
vX.Y.Z - GitHub Release artifacts created by Actions