Application Screenshots
On this page
Screenshots captured automatically by Playwright. To regenerate:
# With devstack running:
SCREENSHOTS=1 cargo xtask e2e --project=setup --project=screenshots
# Or scope to the screenshots spec only (skip the full-refresh setup):
SCREENSHOTS=1 cargo xtask e2e --no-refresh -- screenshots.spec.tsRegeneration
The canonical regeneration command scopes the run to the screenshots spec and skips the full e2e refresh:
SCREENSHOTS=1 cargo xtask e2e --no-refresh -- screenshots.spec.tsOutput is written to docs/modules/ROOT/images/screenshots/ (the canonical,
Git-LFS-tracked location). cargo xtask e2e propagates only the SCREENSHOTS
env var to the Playwright container; the output directory is fixed by the
docker-compose volume mount, so SCREENSHOT_DIR and similar overrides have no
effect.
Requirements:
-
Devstack running with seed data (the spec drives auth as a caseworker and an admin user).
-
Git LFS available on the workstation.
Because the PNGs are Git-LFS-tracked, run git lfs push origin <branch> before
the refs push — otherwise git push is rejected because the LFS objects are
missing. The pre-push hook does not reliably handle this; if a push fails with an
LFS error, run git lfs push origin <branch> and retry.
On a fresh clone the screenshot files appear as small LFS pointer stubs. Run
git lfs pull --include "docs/modules/ROOT/images/screenshots/*.png" to
materialize them, or run the regeneration command to overwrite the stubs with
fresh PNGs.
Regenerate when materially changing a screen (new feature, redesign, layout change); a periodic batched refresh is preferable to regenerating for every CSS tweak, since the screenshot commit deltas are noisy.
