Skip to content

Commit

Permalink
documenting shardTagsEnabled
Browse files Browse the repository at this point in the history
  • Loading branch information
mhan83 committed Aug 15, 2024
1 parent 02065a3 commit c66a80b
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -925,6 +925,26 @@ To split tests in the most efficient way possible, use:

---

### `shardTagsEnabled`
<p><small>| OPTIONAL | BOOLEAN |</small></p>

When sharding is configured and the suite is configured to filter scenarios by [tags](#tags), it is possible for feature files to be allocated to VMs only to be skipped if the
feature file doesn't contain any scenarios matching the specified tags.

With `shardTagsEnabled` enabled, saucectl will filter out feature files that do not contain scenarios matching the given tags. This will prevent wasted VM allocations.

```yaml
suites:
- name: A shard with tags example suite
shard: spec
shardTagsEnabled: true
options:
tags:
- "@smoke and not @flakey"
```

---

### `timeout`

<p><small>| OPTIONAL | DURATION |</small></p>
Expand Down

0 comments on commit c66a80b

Please sign in to comment.