Skip to content

docs: the consumer pattern — the in-repo half of the browser testing convention - #62

Merged
cshuttle merged 2 commits into
mainfrom
docs/consumer-pattern
Aug 19, 2026
Merged

docs: the consumer pattern — the in-repo half of the browser testing convention#62
cshuttle merged 2 commits into
mainfrom
docs/consumer-pattern

Conversation

@cshuttle

Copy link
Copy Markdown
Owner

What

Adds docs/playwright-consumer.md — the consumer-facing half of the browser testing convention (parent: #60), living next to the reusable workflow so it versions with the interface it documents — and links it from the README's playwright-test.yml section.

Covers the in-repo half only: the root-manifest contract the lockstep job assumes, exact @playwright/test pin + lockfile agreement + the Renovate disable rule, the Playwright config baseline (checkout-derived port per nmon#47, webServer booting built assets via vite preview, report paths matching the workflow's failure-artifact glob), test directory layout, the starter smoke shape (a selector only the booted app produces AND a no-page-errors assertion — never a bare HTTP 200), and the subdirectory-frontend harness shape (Topology's case). CI wiring stays in the README; nmon is cited as the living reference throughout.

Closes #61

🤖 Generated with Claude Code

cshuttle and others added 2 commits August 19, 2026 14:17
…convention

The reusable workflow's README covers CI wiring and the pin chain; nothing
covered what a consuming repo looks like on the inside, so each adopter would
reverse-engineer nmon and diverge. docs/playwright-consumer.md is that half:
the root-manifest contract lockstep assumes, the exact-pin + renovate-rule npm
conventions, the config baseline (derived port, vite preview of BUILT assets,
report paths matching the artifact glob), the test-layout split, the starter
smoke (a selector only the booted app produces, plus no page errors — never a
bare HTTP 200), and the subdirectory-frontend shape. nmon stays the living
reference throughout.

Closes #61

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ntainer

Surfaced by the Atlas/Topology seeds: vite preview's default localhost bind
inside the job container is IPv6-only (::1) while the webServer probe dials
127.0.0.1, so the suite times out on a server that is up — and passes on a
dev host, which binds both families.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@cshuttle
cshuttle merged commit d862087 into main Aug 19, 2026
11 checks passed
@cshuttle
cshuttle deleted the docs/consumer-pattern branch August 19, 2026 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consumer pattern document — the in-repo half of the browser testing convention

1 participant