Skip to content

docs: document the headless: false validation error for Playwright Check Suites #784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hlenke merged 1 commit into from
Nov 3, 2026
Merged

docs: document the headless: false validation error for Playwright Check Suites #784

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions detect/synthetic-monitoring/playwright-checks/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,18 @@ Playwright config "/path/to/project/playwright.config.ts" does not exist

Verify that `playwrightConfigPath` points to the correct relative path from your `checkly.config.ts` file.

#### `headless: false` is not supported

```text
✖ [PlaywrightCheck:e2e-test-suite] Invalid property value
The value provided for property "headless" is not valid.
Reason: headless: false is not supported.
Checkly runs all Playwright checks in headless mode. Please remove this
setting from your Playwright configuration, or set it to true.
```

The Checkly CLI rejects `headless: false` in `use` or in any project of your `playwright.config.ts`. It reads the config on your machine, so a value based on `process.env.CHECKLY` fails too. Remove the setting, and run `npx playwright test --headed` when you want to watch a test locally.

### Alert optimization

#### Alerts are triggered too late
Expand Down
Loading