This repository was archived by the owner on Jan 5, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 37
add group usage instructions #1261
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
c78129b
add group usage instructions
MariadeAnton de791b7
just regular weight :pray:
MariadeAnton 45b096a
correct parent, and weight in menu :fingers_crossed:
MariadeAnton 4adb8b0
make group id and name differentiable
MariadeAnton c1bde7b
update to recommend Jiti with full ESM support and frequent updates
MariadeAnton f827b81
Merge branch 'main' into mda-pwsuite-groups
MariadeAnton 2331b46
names should be the same, of course
MariadeAnton File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| title: Adding Playwright Check Suites to groups | ||
| displayTitle: Adding a Playwright Check Suite to a group | ||
| navTitle: Add to a group | ||
| weight: 20 | ||
| slug: /groups-usage | ||
| menu: | ||
| resources: | ||
| parent: "Playwright Check Suites (Alpha)" | ||
| weight: 20 | ||
| --- | ||
|
|
||
| {{< markdownpartial "/_shared/playwright-native-alpha.md" >}} | ||
|
|
||
| You can define a new group, or associate a Playwright Check Suite to an existing group. | ||
|
|
||
| ## Steps | ||
|
|
||
| ### 1. Create a group for your checks | ||
|
|
||
| To define a new group, create a group file, for example `website-group.check.ts`. | ||
|
|
||
| ```typescript {title="website-group.check.ts"} | ||
|
|
||
| import { CheckGroup } from 'checkly/constructs' | ||
|
|
||
| export const myGroup = new CheckGroup('production-group', { | ||
| name: 'Production group', | ||
| activated: true, | ||
| muted: false, | ||
| locations: ['us-east-1', 'eu-west-1'], | ||
| tags: ['mac', 'group'], | ||
| environmentVariables: [], | ||
| apiCheckDefaults: {}, | ||
| concurrency: 100, | ||
| runParallel: true, | ||
| retryStrategy: RetryStrategyBuilder.linearStrategy({ baseBackoffSeconds: 30, maxRetries: 2, sameRegion: false }), | ||
| }) | ||
| ``` | ||
|
|
||
| Learn more about [using groups](https://www.checklyhq.com/docs/cli/constructs-reference/#checkgroup) to unify checks in Checkly. | ||
|
|
||
| ## 2. Associate the group to the check | ||
|
|
||
| When specifying your Playwright Check Suite, you can reference the new or existing group, using its name: | ||
|
|
||
| ```typescript {title="checkly.config.ts"} | ||
| import { defineConfig } from 'checkly' | ||
|
MariadeAnton marked this conversation as resolved.
|
||
|
|
||
| const config = defineConfig({ | ||
| logicalId: 'checkly-website', | ||
| projectName: 'checkly-website', | ||
| checks: { | ||
| playwrightConfigPath: './playwright.config.ts', | ||
| playwrightChecks: [ | ||
| { | ||
| name: 'checkly-website', | ||
| frequency: 10, | ||
| locations: ['us-east-1',], | ||
| groupName: 'Production group', // use the name of the group you created | ||
| }, | ||
| ], | ||
| }, | ||
| cli: { | ||
| runLocation: 'us-east-1', | ||
| }, | ||
| }) | ||
|
|
||
| export default config | ||
| ``` | ||
|
|
||
| ## 3. Deploy to apply the changes | ||
|
|
||
| ```bash {title="Terminal"} | ||
| npx checkly deploy --preview #confirm what will be deployed | ||
| npx checkly deploy # deploy | ||
| ``` | ||
|
|
||
| You can now see your Playwright Check Suite in your group. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.