Echo — Internal runbook (operate & release)

Echo — Internal runbook (operate & release)

Operational reference for maintaining and releasing Echo. Closing doc for the Echo pilot (Plans 1–3).

Where things live

Thing Location
Source repo (private) C:\Projects\superwhisper-clone (branch master)
Build instructions superwhisper-clone/BUILD.md
PyInstaller spec superwhisper-clone/echo.spec (signing hook commented in)
Releases repo (public) bockbr/echo-releases
Latest release v0.1.0 — asset Echo-windows-x64.zip (152 MB)
Release URL https://github.com/bockbr/echo-releases/releases/download/v0.1.0/Echo-windows-x64.zip
Company site repo jct-www → product page jct-www/tools/echo/index.html (jacksoncreektech.ca)
Issue tracker JSM project JCT on jackson-creek-tech.atlassian.net, label echo
Issue filter project = JCT AND labels = echo (seeded issues JCT-7..JCT-14)

Cut a new release

  1. Build per superwhisper-clone/BUILD.md (build interpreter = Python 3.13, must match PyInstaller). Output → dist\Echo\Echo.exe.
    • SECURITY GATE: confirm bundled config.yaml api key is EMPTY before zipping.
  2. Zip the one-folder build:
    Compress-Archive -Path dist\Echo\* -DestinationPath Echo-windows-x64.zip -Force
  3. Publish the release on the public releases repo:
    gh release create vX.Y.Z --repo bockbr/echo-releases Echo-windows-x64.zip
  4. Update the site — in jct-www/tools/echo/index.html:
    • bump the version + changelog entry,
    • update the download CTA label and link to the new asset URL.
  5. Commit & push jct-www (static site auto-deploys to jacksoncreektech.ca).

Feedback loop

  • Site feedback button → JSM customer portal (tokenless; no secret in the static site).
  • New requests land in JCT; tag with label echo to keep them in the tool's filter.

Known carryover / future work

Item Note
374 MB build size One-folder build is large; CPU-only slimming (drop unused GPU/CUDA payloads) is a future optimization to shrink the download.
2 stale tests Two pre-existing failing/stale tests carried over from adoption; not introduced by the rebrand. Triage when revisiting the suite.
history.txt git-tracked Runtime data is currently tracked in git; candidate to git rm --cached + add to .gitignore.
Unsigned binary Ships unsigned (SmartScreen warning on download). Signing hook ready in echo.spec/BUILD.md — enable Azure Trusted Signing or an EV cert when warranted.