Skip to content

Generate the docs screenshots with Playwright - #456

Open
Bohreromir wants to merge 1 commit into
fix/db-default-portfrom
docs/screenshots-script
Open

Bohreromir wants to merge 1 commit into
fix/db-default-portfrom
docs/screenshots-script

Conversation

@Bohreromir

Copy link
Copy Markdown
Member

Description

Adds a script to update screenshots automatically with npm run docs:screenshots

Docs

Release note

Checklist

Author

  • AI review done, findings addressed
  • Tests added or updated
  • Changelog updated (if the repo keeps one)

Reviewer

  • Useful comments and logging
  • Docs added or updated per the style guide

Acceptance

  • Check for release notes and docs

@Bohreromir
Bohreromir added this pull request to stack #455 November 10, 2026 19:17
@Bohreromir Bohreromir mentioned this pull request Nov 10, 2026
1 of 6 tasks
@github-actions

github-actions Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 67.5% 9184 / 13605
🔵 Statements 66.45% 12364 / 18604
🔵 Functions 68.29% 2966 / 4343
🔵 Branches 57.45% 5180 / 9015
File CoverageNo changed files found.
Generated in workflow #1269 for commit fc08ff1 by the Vitest Coverage Report Action

npm run docs:screenshots builds with .env.test and runs the specs in
e2e/docs-screenshots in a separate Playwright project, which writes the
images to docs/modules/cockpit/images. The normal E2E run skips them.
@Bohreromir
Bohreromir force-pushed the docs/screenshots-script branch from fb4ea57 to fc08ff1 Compare November 10, 2026 19:21
@Bohreromir
Bohreromir marked this pull request as ready for review November 10, 2026 19:22
@Bohreromir Bohreromir self-assigned this Nov 10, 2026
@Bohreromir Bohreromir moved this to Development: Waiting for Review in Stackable Engineering Nov 10, 2026
@dervoeti dervoeti moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Nov 11, 2026
@dervoeti
dervoeti self-requested a review November 11, 2026 09:15

@dervoeti dervoeti left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically looks good to me, Claude found one thing that sounds reasonable:

The screenshot depends on the fonts of the machine that runs it (e2e/docs-screenshots/dashboard.spec.ts:56, playwright.config.ts:10). Neither src/app.css nor package.json bundles a font, so the app falls back to the Tailwind system font stack. Every contributor who runs the script will commit a slightly different binary and the docs will keep changing look.

Fix:

  • Option 1: run the docs project in the official Playwright container (mcr.microsoft.com/playwright:v<same version as @playwright/test>-noble).
  • Option 2: bundle a web font.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Development: In Review

Development

Successfully merging this pull request may close these issues.

2 participants