From e17d477af11d94ca0f70d4cfc25ab5a3e3d4e755 Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Mon, 2 Nov 2026 18:56:58 -0500 Subject: [PATCH] docs: document the headless: false validation error for Playwright Check Suites The CLI rejects headless: false in use or in any project of playwright.config.ts (checkly 10.1.0, "headless: false is not supported"). It reads the config locally, so a value based on process.env.CHECKLY fails validation too. Verified with `npx checkly test --list` on a minimal project. Comes from the unmerged troubleshooting branch of #154, whose suggested workaround (headless: process.env.CHECKLY ? true : false) no longer passes validation. Co-Authored-By: Claude Opus 5.5 --- .../playwright-checks/configuration.mdx | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/detect/synthetic-monitoring/playwright-checks/configuration.mdx b/detect/synthetic-monitoring/playwright-checks/configuration.mdx index 3a304a34..54a0ed10 100644 --- a/detect/synthetic-monitoring/playwright-checks/configuration.mdx +++ b/detect/synthetic-monitoring/playwright-checks/configuration.mdx @@ -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