Repository navigation
docs: document the headless: false validation error for Playwright Check Suites - #784
Merged
Merged
Conversation
…eck 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 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Affected Components
Notes for the Reviewer
This adds one entry under Common issues & troubleshooting → Configuration errors in
detect/synthetic-monitoring/playwright-checks/configuration.mdx: "headless: falseis not supported", with the exact error message and the fix.Where it comes from. It's taken from the unmerged branch
mda-troubleshooting-section(#154). That branch said Checkly ignoresheadless: falseand suggestedheadless: process.env.CHECKLY ? true : falseas a workaround. Current CLI behaviour is different:checkly@10.1.0rejectsheadless: falseinuseor in any project (validateHeadlessModeinconstructs/playwright-check).npx checkly test --list. With the conditional value, validation fails: the CLI reads the config on your machine, whereCHECKLYisn't set. Without the setting, the same project validates. The error block in this PR is the CLI's actual output.The rest of that branch is already on this page ("webServer configuration requires additional files", "No tests found"), so nothing else carries over. The branch is being deleted.
Not included: that branch also added
multistep-checks/troubleshootingto the nav. That page is onmainbut isn't in the nav. I left it out on purpose: its content is generic ("Implement token refresh logic", "Add monitoring for long-running operations"), and adding it to the nav would make it more visible. It should be rewritten or deleted with a redirect, in a separate change.🤖 Generated with Claude Code