Add an About Screen and Debug Dump
- Goal
-
Ship a discoverable About surface and a one-action redacted diagnostics dump.
- Why
Steps (any stack)
-
Generate build metadata in CI — commit SHA, version, channel, timestamp, target triple. Emit a source file or embedded resource; do not shell out to
gitin production builds. -
Expose a version API in-process (e.g.
BuildInfo.version,BuildInfo.commit). -
Wire the UI or CLI:
-
GUI: Help → About (version, build, channel, OS, license, Save debug dump)
-
CLI:
app --versionandapp debug-dump [--out path] -
TUI: About pane + same dump command
-
-
Implement the dump as a zip or folder:
-
build info
-
non-secret settings
-
last logs
-
optional hardware/OS summary
-
-
Redact tokens, passwords, cookies, and secret-store contents by default.
-
Document in README/Help: where About lives and what to attach to issues.
Acceptance checks
-
About /
--versionshows marketing version and build id -
Dump works on a clean install (no repo/.git required)
-
Opening the dump does not reveal secrets in a spot check
-
A teammate can match the build id to a CI run