Skip to content

Quick onboarding tweaks #1274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Quick onboarding tweaks #1274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cf291d
update instructions for clarity
MariadeAnton Apr 30, 2025
470026d
testCommand was missing
MariadeAnton Apr 30, 2025
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
4 changes: 2 additions & 2 deletions site/content/docs/playwright-checks/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The alpha version gets updated daily with new improvements. You can follow updat
npm install --save-dev jiti typescript
```

### 3. Test and create a monitor with all your tests
### 3. [If you are new to Checkly] Test and create a monitor with all your tests

From inside your repository's source code directory, run:

Expand All @@ -79,7 +79,7 @@ The alpha version gets updated daily with new improvements. You can follow updat

Of course, you can now run `npx checkly deploy` and have a big monitor that checks your whole suite.

It's likely only some tagged tests or Playwright projects need to become monitors. You can now update your `checkly.config.ts/js` file to select the tests to become individual monitors, with their own schedule, location and configuration.
It's likely that only some tagged tests or Playwright projects need to become monitors. You can now update your `checkly.config.ts/js` file to select the tests to become individual monitors, with their own schedule, location, and configuration.

Here's a fully working example. Adjust the `pwProjects` and `pwTags` to ones that exist in your code.

Expand Down
4 changes: 3 additions & 1 deletion site/content/docs/playwright-checks/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ menu:
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.
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 references

Expand Down Expand Up @@ -48,6 +48,8 @@ These are the available monitoring configuration options:

* `installCommand:` Override the command to install dependencies, by default it'll use `npm install --dev`.

* `testCommand:` Override the command to test, by default it uses npx playwright test with the tags, projects, and config file options your check specifies.

* `activated:` A boolean value to activate/run your check or not.

* `muted:` A boolean value to mute Alert notifications.
Expand Down
Loading