mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-25 17:22:50 +00:00
f196a1eb29
Some checks are pending
Argos CI / take-screenshots (push) Waiting to run
Build Hash Router / Build Hash Router (push) Waiting to run
Canary Release / Publish Canary (push) Waiting to run
CodeQL / Analyze (javascript) (push) Waiting to run
Continuous Releases / Continuous Releases (push) Waiting to run
E2E Tests / E2E — Yarn v1 (18.0) (push) Waiting to run
E2E Tests / E2E — Yarn v1 (20) (push) Waiting to run
E2E Tests / E2E — Yarn v1 (22) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (node-modules, -s) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (node-modules, -st) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (pnp, -s) (push) Waiting to run
E2E Tests / E2E — Yarn Berry (pnp, -st) (push) Waiting to run
E2E Tests / E2E — npm (push) Waiting to run
E2E Tests / E2E — pnpm (push) Waiting to run
|
||
|---|---|---|
| .. | ||
| tests | ||
| .gitignore | ||
| README.md | ||
| package.json | ||
| playwright.config.ts | ||
Argos visual regression tests
We use Argos CI to detect visual regressions on Docusaurus.
This workspace can be run manually, but is generally run through the Argos GitHub Action.
The workflow execute those following steps:
- Build the website locally with
yarn build:website:fast - Start the website server with
yarn serve:websiteon http://localhost:3000 - Take screenshots of all pages found in
sitemap.xmlwith Playwright - Upload all screenshots to Argos CI
This workflow runs for main and PR branches, and add a commit status to each PR with a visual diff that we can easily inspect.
Some additional capabilities:
- Use ./tests/screenshot.spec.ts to customize the screenshots we take, eventually filter out some useless sitemap pages like versioned docs
- Use ./tests/screenshot.css to hide flaky CSS elements: iframe, video, gif...