mirror of
https://github.com/block/buzz.git
synced 2026-10-27 04:30:52 +00:00
feat: desktop-screenshot skill to stop agents uploading relay media to PRs (#862)
This commit is contained in:
1
.agents/skills/desktop-screenshot/SKILL.md
Symbolic link
1
.agents/skills/desktop-screenshot/SKILL.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../desktop/src-tauri/src/managed_agents/screenshot_skill.md
|
||||
1
.claude/skills/desktop-screenshot/SKILL.md
Symbolic link
1
.claude/skills/desktop-screenshot/SKILL.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../desktop/src-tauri/src/managed_agents/screenshot_skill.md
|
||||
1
.codex/skills/desktop-screenshot/SKILL.md
Symbolic link
1
.codex/skills/desktop-screenshot/SKILL.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../desktop/src-tauri/src/managed_agents/screenshot_skill.md
|
||||
1
.goose/skills/desktop-screenshot/SKILL.md
Symbolic link
1
.goose/skills/desktop-screenshot/SKILL.md
Symbolic link
@@ -0,0 +1 @@
|
||||
../../../desktop/src-tauri/src/managed_agents/screenshot_skill.md
|
||||
@@ -224,6 +224,11 @@ See [TESTING.md](TESTING.md) for the full multi-agent E2E guide.
|
||||
|
||||
### Desktop Screenshots (Playwright)
|
||||
|
||||
> **Do NOT use `sprout upload`, the relay media endpoint, or any third-party
|
||||
> image host for PR screenshots.** Relay media URLs fail through GitHub's camo
|
||||
> proxy. Always use `scripts/post-screenshots.sh` — see the `desktop-screenshot`
|
||||
> skill for the full workflow.
|
||||
|
||||
The desktop app requires the E2E mock bridge to render — it cannot run in a plain
|
||||
browser. Use `just desktop-screenshot` to capture screenshots (builds frontend,
|
||||
starts preview server, runs Playwright automatically):
|
||||
|
||||
97
desktop/src-tauri/src/managed_agents/screenshot_skill.md
Normal file
97
desktop/src-tauri/src/managed_agents/screenshot_skill.md
Normal file
@@ -0,0 +1,97 @@
|
||||
---
|
||||
name: desktop-screenshot
|
||||
description: >
|
||||
Capture desktop app screenshots and post them to GitHub PRs with immutable URLs.
|
||||
version: 1
|
||||
---
|
||||
|
||||
# Desktop Screenshot Skill
|
||||
|
||||
## CRITICAL: How to Host Screenshots for PRs
|
||||
|
||||
**NEVER use `sprout upload`, the relay media endpoint, or any third-party image
|
||||
host (imgur, imgbb, etc.) for PR screenshots.** Relay media URLs fail through
|
||||
GitHub's camo proxy (`Non-Image content-type returned`). External hosts are
|
||||
unreliable and may expose content.
|
||||
|
||||
**ALWAYS use `scripts/post-screenshots.sh`** — it hosts PNGs on a per-developer
|
||||
git branch with immutable commit-SHA URLs that render correctly on GitHub.
|
||||
|
||||
## Step 1 — Capture Screenshots
|
||||
|
||||
`just desktop-screenshot` builds the frontend, starts a preview server, and
|
||||
runs Playwright with the mock bridge (no relay needed).
|
||||
|
||||
```bash
|
||||
just desktop-screenshot --name home
|
||||
just desktop-screenshot --name channel --route /channels/general
|
||||
just desktop-screenshot --name ctx-menu --right-click channel-random --clip 0,200,320,300
|
||||
just desktop-screenshot --name sidebar --active-channel general --messages /tmp/msgs.json --clip 0,0,256,720
|
||||
```
|
||||
|
||||
**Flags:** `--name` (filename, required), `--route` (client route), `--active-channel`
|
||||
(channel to view), `--click`/`--right-click`/`--hover` (interact before capture),
|
||||
`--clip` (crop as `x,y,w,h`), `--messages` (JSON file), `--wait` (ms, default 2000),
|
||||
`--viewport` (WxH, default 1280x720), `--outdir` (default `test-results/screenshots`).
|
||||
|
||||
Output: PNG path on stdout.
|
||||
|
||||
### Injecting Messages
|
||||
|
||||
Write a JSON array to a temp file. `channelName` and `content` are required:
|
||||
|
||||
```json
|
||||
[
|
||||
{"channelName": "random", "content": "Hey check this out", "kind": 40002},
|
||||
{"channelName": "random", "content": "Another message"}
|
||||
]
|
||||
```
|
||||
|
||||
Without `--active-channel`, the helper navigates to the message channel (for
|
||||
showing content). With `--active-channel`, messages can target other channels
|
||||
while the camera stays put (for unread indicators, badges).
|
||||
|
||||
### Available Mock Channels
|
||||
|
||||
`general`, `random`, `design`, `sales`, `engineering`, `agents`, `watercooler`,
|
||||
`announcements`, `alice-tyler`, `bob-tyler`.
|
||||
|
||||
`general` has pre-seeded messages (always shows `hasUnread`). Use `engineering`
|
||||
for "no unread" visual states.
|
||||
|
||||
## Step 2 — Post to a PR
|
||||
|
||||
```bash
|
||||
./scripts/post-screenshots.sh <PR-number> test-results/screenshots
|
||||
./scripts/post-screenshots.sh <PR-number> test-results/screenshots body.md
|
||||
```
|
||||
|
||||
The script pushes images to `agent-screenshots/<github-username>` and posts a
|
||||
PR comment with `## Screenshots` and all images. Re-runs overwrite that PR's
|
||||
images only.
|
||||
|
||||
### Body Templates
|
||||
|
||||
The optional third argument is a markdown file with `{{filename}}` placeholders
|
||||
(without `.png`). Images not referenced by a placeholder are appended at the end.
|
||||
|
||||
```markdown
|
||||
### Context menu
|
||||
Right-click shows "Star channel".
|
||||
|
||||
{{01-ctx-menu}}
|
||||
|
||||
### Starred section
|
||||
`engineering` appears under Starred.
|
||||
|
||||
{{02-starred}}
|
||||
```
|
||||
|
||||
## Gotchas
|
||||
|
||||
1. **Stale server** — `reuseExistingServer: true` means a prior build serves old
|
||||
code. Kill port 4173 and rebuild (`cd desktop && pnpm run build`) after code changes.
|
||||
2. **Clip for readability** — full 1280x720 screenshots are hard to read for sidebar
|
||||
features. Sidebar = 256px wide; context menus ~450px.
|
||||
3. **`post-screenshots.sh` requires `gh` auth** — the script uses `gh api` and
|
||||
`gh pr comment`. Ensure `gh auth status` succeeds.
|
||||
Reference in New Issue
Block a user