Repository navigation
Fill gaps from assistant conversations: clarify PlaywrightCheck engine scope - #511
Merged
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
hlenke
reviewed
Nov 3, 2026
hlenke
left a comment
Member
There was a problem hiding this comment.
Needs changes · The added sentence says engine is not part of checks.playwrightChecks, but the CLI accepts it there and constructs/project.mdx on main documents it. Keep only the true half: there is no project-wide default.
Merge readiness
- Contradicts
main.constructs/project.mdx:635onmainlistsengineas a parameter of eachchecks.playwrightChecksentry, linking back to this page's#param-engine(added in 185843d, DOC-88). As written, the two pages disagree. - CI passes. Mergeable, clean.
- No overlap with other open PRs on
constructs/playwright-check.mdx.
Inline comments: 1 blocker.
What I checked
- Read the full diff
94e4497f..refs/docs-review/pr-511(1 file, +2) and the surroundingenginesection. - checkly-cli origin/main@4e450744,
packages/cli/src/services/checkly-config-loader.ts:47-51: the type of achecks.playwrightChecksentry (PlaywrightSlimmedProp) includesengine. It was added in a5509e5d, "Support engine selection for Playwright Check Suites" (#1319, 2026-05-27). packages/cli/src/services/project-parser.ts:247-261: each config entry is spread intonew PlaywrightCheck(...), so the CLI applies anengineset there.- Published
checkly@10.1.0(dist/services/checkly-config-loader.d.ts):PlaywrightSlimmedPropincludes'engine'.CheckConfigDefaults, the project-widechecksdefaults, does not, so the "no project-wide default" half is correct. constructs/project.mdx:598-636onmaindocumentsenginein thechecks.playwrightChecksparameter table.gh pr checks 511: all pass.gh pr view 511:MERGEABLE/CLEAN.- No end-to-end test: a Playwright Check Suite run needs a Playwright project with installed dependencies and suite runners that the local app may not provide. The CLI types and parser settle the claim.
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.
Summary
Clarify that the
engineoption on Playwright Check Suites can only be set per-construct and is not available as a project-wide default incheckly.config.ts.Changes
constructs/playwright-check.mdx: Add a one-line note under theenginefield explaining it is not part ofchecks.playwrightChecksdefaults and cannot be configured globally.Context
Recent assistant conversations showed users asking whether the Node/Bun engine can be pinned inside
checkly.config.ts. The existingenginedocumentation covered auto-detection sources thoroughly but did not state the scoping rule explicitly, forcing users to infer it.