Skip to content

Commit af724ee

Browse files
authored
Add new logicalId (#1288)
Fix jiti vs ts-node in onboarding description
1 parent cd3e888 commit af724ee

File tree

3 files changed

+19
-8
lines changed

3 files changed

+19
-8
lines changed

site/content/docs/playwright-checks/_index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The alpha version gets updated daily with new improvements. You can follow updat
5858

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

61-
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).
61+
If you're using TypeScript, install the dev dependencies [`jiti`](https://www.npmjs.com/package/jiti) and [`typescript`](https://www.npmjs.com/package/typescript).
6262

6363
```bash {title="Terminal"}
6464
npm install --save-dev jiti typescript
@@ -98,23 +98,25 @@ Here's a fully working example. Adjust the `pwProjects` and `pwTags` to ones tha
9898
{
9999
/* Create a multi-browser check that runs
100100
every 5 mins.*/
101-
name: 'multi-browser',
101+
name: 'Multi Browser Suite',
102+
logicalId: 'multi-browser',
102103
pwProjects: ['chromium', 'firefox', 'webkit'], // Reference the project or projects in your playwright config
103104
frequency: Frequency.EVERY_5M, // set your ideal frequency
104105
locations: ['us-east-1', 'eu-west-1'], // add your locations
105106
},
106107
{
107108
/* Create a check that runs the critical tagged tests every 10 mins */
108-
name: 'checkly-tagged',
109-
pwTags: 'checkly', // Reference an existing tag in your tests
109+
name: 'Checkly Tagged tests',
110+
logicalId: 'checkly-tagged',
111+
pwTags: '@checkly', // Reference an existing tag in your tests
110112
frequency: Frequency.EVERY_10M, // set your ideal frequency
111-
locations: ['eu-west-1'],
113+
locations: ['us-east-1'],
112114
},
113115
],
114116
},
115117
/* The default location to use when running npx checkly test */
116118
cli: {
117-
runLocation: 'eu-west-1',
119+
runLocation: 'us-east-1',
118120
retries: 0, // full test retries, when running npx checkly test
119121
},
120122
})

site/content/docs/playwright-checks/add-to-group.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { CheckGroup } from 'checkly/constructs'
2626

2727
export const myGroup = new CheckGroup('production-group', {
2828
name: 'Production group',
29+
logicalID: 'production-group',
2930
activated: true,
3031
muted: false,
3132
locations: ['us-east-1', 'eu-west-1'],
@@ -54,7 +55,9 @@ When specifying your Playwright Check Suite, you can reference the new or existi
5455
playwrightConfigPath: './playwright.config.ts',
5556
playwrightChecks: [
5657
{
57-
name: 'checkly-website',
58+
name: 'Critical Tests',
59+
logicalId: 'critical-tests',
60+
pwTags:'critical',
5861
frequency: 10,
5962
locations: ['us-east-1',],
6063
groupName: 'Production group', // use the name of the group you created

site/content/docs/playwright-checks/reference.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ To define your Playwright Check Suite, you use the `checkly.config.ts/js` file.
1616
Each Playwright Check Suite is connected to an existing reference in your `playwright.config.ts/js` file.
1717
During the Alpha, a Playwright Check Suite can last up to 20 minutes. This limit is open to be increased / decreased after the alpha.
1818

19+
## Playwright Check Suite definition
20+
21+
* `name` - a human friendly name for your check suite.
22+
* `logicalId` - a reference for your check suite.
23+
1924
## Playwright references
2025

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

0 commit comments

Comments
 (0)