Skip to content

Fill gaps from assistant conversations: clarify PlaywrightCheck engine scope - #511

Merged
hlenke merged 2 commits into
mainfrom
mintlify/0b5fc2f1
Nov 4, 2026
Merged

hlenke merged 2 commits into
mainfrom
mintlify/0b5fc2f1

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarify that the engine option on Playwright Check Suites can only be set per-construct and is not available as a project-wide default in checkly.config.ts.

Changes

  • constructs/playwright-check.mdx: Add a one-line note under the engine field explaining it is not part of checks.playwrightChecks defaults 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 existing engine documentation covered auto-detection sources thoroughly but did not state the scoping rule explicitly, forcing users to infer it.

@mintlify

mintlify Bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 4, 2026, 1:19 AM

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:635 on main lists engine as a parameter of each checks.playwrightChecks entry, 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 surrounding engine section.
  • checkly-cli origin/main@4e450744, packages/cli/src/services/checkly-config-loader.ts:47-51: the type of a checks.playwrightChecks entry (PlaywrightSlimmedProp) includes engine. 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 into new PlaywrightCheck(...), so the CLI applies an engine set there.
  • Published checkly@10.1.0 (dist/services/checkly-config-loader.d.ts): PlaywrightSlimmedProp includes 'engine'. CheckConfigDefaults, the project-wide checks defaults, does not, so the "no project-wide default" half is correct.
  • constructs/project.mdx:598-636 on main documents engine in the checks.playwrightChecks parameter 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.

Comment thread constructs/playwright-check.mdx Resolved
@hlenke
hlenke enabled auto-merge (squash) November 4, 2026 01:19
@hlenke
hlenke merged commit 6b7fe69 into main Nov 4, 2026
5 of 6 checks passed
@hlenke
hlenke deleted the mintlify/0b5fc2f1 branch November 4, 2026 01:22

This branch was successfully deployed

1 active deployment
staging — 80542734 Deployed Nov 4, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant