screenshot-pr

Screenshot PR Changes

Capture UI changes for a pull request across three standard viewports using shot-scraper.

Requires: shot-scraper available on PATH (it is a system-level utility, not a per-project dependency — do not install it with uv or pip inside the project).

Check it is present before proceeding:

which shot-scraper && shot-scraper --version

If the command is missing, ask the user to install it globally (e.g. uv tool install shot-scraper --global, pipx install shot-scraper, or their preferred method) and confirm Chromium is available (shot-scraper install). Do not install it yourself.

---

Step 0 — Discover the base URL

Run these checks in order and stop at the first hit:

a) Check .env (or .env.local) in the repo root:

grep -E "(BASE_URL|SITE_URL|APP_URL)" .env .env.local 2>/dev/null | head -10

Look for vars like MITX_ONLINE_BASE_URL, SITE_URL, NEXT_PUBLIC_BASE_URL.

b) Check docker-compose.yml for env defaults:

grep -E "(BASE_URL|APISIX_PORT|_PORT)" docker-compose.yml 2>/dev/null | head -20

Pay attention to APISIX_PORT (default 9080) — screenshots of authenticated pages must go through the APISIX port, not the raw app port, so session cookies work. If the app hostname is api.open.odl.local and APISIX is at 8065, the base URL for screenshots is http://api.open.odl.local:8065.

c) Probe common ports for a live server:

for port in 9080 3000 5173 8000 8013; do
  curl -s -o /dev/null -w "%{http_code} localhost:$port\n" --max-time 1 "http://localhost:$port/" 2>/dev/null
done

d) Check the README or session context for any URLs mentioned.

Record two values: base_url (used for all screenshot URLs) and login_url (<base_url>/login, used for auth). If nothing is found, ask the user.

---

Step 1 — Establish an auth context

Authentication in this dev stack flows through APISIX → Keycloak. The shot-scraper --auth flag takes a Playwright storage-state JSON file; this step generates or reuses one.