Skip to content
This repository was archived by the owner on Jan 5, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 8 additions & 6 deletions site/content/docs/playwright-checks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The alpha version gets updated daily with new improvements. You can follow updat

### 2. [Optional] If you're using TypeScript

If you're using TypeScript, install the dev dependencies [`ts-node`](https://www.npmjs.com/package/ts-node) and [`typescript`](https://www.npmjs.com/package/typescript).
If you're using TypeScript, install the dev dependencies [`jiti`](https://www.npmjs.com/package/jiti) and [`typescript`](https://www.npmjs.com/package/typescript).

```bash {title="Terminal"}
npm install --save-dev jiti typescript
Expand Down Expand Up @@ -98,23 +98,25 @@ Here's a fully working example. Adjust the `pwProjects` and `pwTags` to ones tha
{
/* Create a multi-browser check that runs
every 5 mins.*/
name: 'multi-browser',
name: 'Multi Browser Suite',
logicalId: 'multi-browser',
pwProjects: ['chromium', 'firefox', 'webkit'], // Reference the project or projects in your playwright config
frequency: Frequency.EVERY_5M, // set your ideal frequency
locations: ['us-east-1', 'eu-west-1'], // add your locations
},
{
/* Create a check that runs the critical tagged tests every 10 mins */
name: 'checkly-tagged',
pwTags: 'checkly', // Reference an existing tag in your tests
name: 'Checkly Tagged tests',
logicalId: 'checkly-tagged',
pwTags: '@checkly', // Reference an existing tag in your tests
frequency: Frequency.EVERY_10M, // set your ideal frequency
locations: ['eu-west-1'],
locations: ['us-east-1'],
},
],
},
/* The default location to use when running npx checkly test */
cli: {
runLocation: 'eu-west-1',
runLocation: 'us-east-1',
retries: 0, // full test retries, when running npx checkly test
},
})
Expand Down
5 changes: 4 additions & 1 deletion site/content/docs/playwright-checks/add-to-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { CheckGroup } from 'checkly/constructs'

export const myGroup = new CheckGroup('production-group', {
name: 'Production group',
logicalID: 'production-group',
activated: true,
muted: false,
locations: ['us-east-1', 'eu-west-1'],
Expand Down Expand Up @@ -54,7 +55,9 @@ When specifying your Playwright Check Suite, you can reference the new or existi
playwrightConfigPath: './playwright.config.ts',
playwrightChecks: [
{
name: 'checkly-website',
name: 'Critical Tests',
logicalId: 'critical-tests',
pwTags:'critical',
frequency: 10,
locations: ['us-east-1',],
groupName: 'Production group', // use the name of the group you created
Expand Down
8 changes: 7 additions & 1 deletion site/content/docs/playwright-checks/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@ To define your Playwright Check Suite, you use the `checkly.config.ts/js` file.
Each Playwright Check Suite is connected to an existing reference in your `playwright.config.ts/js` file.
During the Alpha, a Playwright Check Suite can last up to 20 minutes. This limit is open to be increased / decreased after the alpha.

## Playwright Check Suite definition

* `name` - a human friendly name for your check suite.
* `logicalId` - a reference for your check suite.

## Playwright references

The following Playwright references are available to create a Playwright Monitor:
Expand Down Expand Up @@ -67,7 +72,8 @@ checks: {
playwrightChecks: [
{
// Run E2E tagged tests across browsers in 4 locations
name: 'E2E',
name: 'E2E test suite',
logicalId: 'e2e-test-suite',
pwProjects: ['chromium', 'firefox', 'webkit'], // Reference the project or projects in playwright.config file
pwTags: 'e2e', // Reference an existing tag in your tests
installCommand: 'npm install --dev', // Optionally override default dependencies install command
Expand Down
Loading