Skip to content

Commit f1a342c

Browse files
oxoxDevclaude
andcommitted
docs(release): address CodeRabbit review (#971)
- RELEASE-MANUAL-SMOKE.md sign-off fence: add `text` language tag (markdownlint MD040). - RELEASE-MANUAL-SMOKE.md Linux toast: rephrase duplicate "only" — "CI Linux sees only Xvfb; this surface verifies on a real desktop". - TESTING-STRATEGY.md "Not driver-automatable" section: clarify that RELEASE-MANUAL-SMOKE.md is the source of truth and the bullets are examples, not the full list. - RELEASE_POLICY.md step 5: spell out that the sign-off block is pasted verbatim with checked items intact. Refs #971 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent e9fce60 commit f1a342c

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/RELEASE-MANUAL-SMOKE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Applies to every release, all platforms.
3939
### Linux
4040

4141
- [ ] **`.deb` and/or `.AppImage` install on a clean Ubuntu 22.04**`sudo dpkg -i openhuman_*.deb` or `chmod +x openhuman-*.AppImage && ./openhuman-*.AppImage`. Expected: no missing-dependency errors; app launches.
42-
- [ ] **OS-native notification toasts fire** — Trigger a notification from inside the app (e.g. memory captured, agent finished). Expected: a libnotify-style toast appears outside the app window. (CI Linux only sees Xvfbthis surface only verifies on a real desktop.)
42+
- [ ] **OS-native notification toasts fire** — Trigger a notification from inside the app (e.g. memory captured, agent finished). Expected: a libnotify-style toast appears outside the app window. (CI Linux sees only Xvfb; this surface verifies on a real desktop.)
4343

4444
### Cross-platform
4545

@@ -62,7 +62,7 @@ Applies to every release, all platforms.
6262

6363
## Sign-off
6464

65-
```
65+
```text
6666
Release: vX.Y.Z
6767
Tester: @<github-handle>
6868
Date: YYYY-MM-DD

docs/RELEASE_POLICY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ Implementation: `app/src/utils/oauthAppVersionGate.ts`, `app/src/utils/desktopDe
3232
2. When dropping support for older installs, set **`VITE_MINIMUM_SUPPORTED_APP_VERSION`** to the new floor **before** or **with** that release (repo Actions variables + both workflow steps above).
3333
3. Remove, redirect, or retire older stable installers and stale **updater** entries from user-facing surfaces (GitHub Release assets, website, CDN, updater feed). Confirm deprecated artifacts are not reachable from default install/update flows.
3434
4. Smoke-test **Gmail connect** on a fresh install from **releases/latest**.
35-
5. Complete the [manual smoke checklist](./RELEASE-MANUAL-SMOKE.md) and paste the sign-off block into the release PR description before tagging.
35+
5. Complete the [manual smoke checklist](./RELEASE-MANUAL-SMOKE.md), then paste the completed sign-off block (verbatim, with every checked item left checked) into the release PR description before tagging.

docs/TESTING-STRATEGY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,14 @@ bash app/scripts/e2e-run-spec.sh test/e2e/specs/<your-spec>.spec.ts <id>
120120

121121
## Not driver-automatable — manual smoke required
122122

123-
Some surfaces cannot be driven by WDIO / Appium because they cross OS-level trust boundaries or hardware paths. These ship with a documented manual smoke checklist ([`docs/RELEASE-MANUAL-SMOKE.md`](./RELEASE-MANUAL-SMOKE.md)) and a sign-off on the release PR:
123+
Some surfaces cannot be driven by WDIO / Appium because they cross OS-level trust boundaries or hardware paths. The complete checklist + sign-off block lives in [`docs/RELEASE-MANUAL-SMOKE.md`](./RELEASE-MANUAL-SMOKE.md) — that file is the source of truth for what must be verified per release. Examples of what it covers:
124124

125125
- macOS TCC permission prompts (Accessibility, Input Monitoring, Screen Recording, Microphone)
126126
- Gatekeeper signature validation on first launch
127127
- Code-sign integrity (`codesign --verify --deep --strict`)
128128
- DMG install / drag-to-Applications flow
129129
- Auto-update download + relaunch
130-
- OS-native notification toasts on Linux CI (no display server visible to the driver beyond Xvfb)
130+
- OS-native notification toasts on Linux (no display server visible to the driver beyond Xvfb)
131131

132132
If a feature has no automated coverage AND is not on the manual smoke list, treat it as untested — open a coverage gap.
133133

0 commit comments

Comments
 (0)