Skip to content
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.

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

docs: Support sharding by scenario for playwright-cucumber #2903

Merged
merged 2 commits into from
Aug 26, 2024
Merged
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
10 changes: 7 additions & 3 deletions docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -920,10 +920,14 @@ suites:

<p><small>| OPTIONAL | STRING |</small></p>

When sharding is configured, `saucectl` automatically splits the tests (e.g., by spec or concurrency) so that they can easily run in parallel.
For sharding by concurrency, `saucectl` splits test files into several groups (the number of groups is determined by the concurrency setting). Each group will then run as an individual job.
When sharding is enabled, `saucectl` automatically distributes the tests to run in parallel.

Selectable values: `spec` to shard by spec file, `concurrency` to shard by concurrency. Remove this field or leave it empty `""` for no sharding.
Selectable options:
- `spec`: Shards by spec file. `saucectl` starts a separate job for each spec file.
- `concurrency`: Shards by concurrency level. `saucectl` divides test files into multiple groups based on the specified concurrency setting. Each group runs as an individual job.
- `scenario`: Shards by scenario name. `saucectl` gathers scenario names from the test files and starts a job for each scenario name. Scenarios with the same name are grouped into a single job.

To disable sharding, either remove this field or set it to `""`.

```yaml
suites:
Expand Down
Loading