Skip to content

Commit

Permalink
docs: elaborate on smartRetry requirements for cypress (#2875)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexplischke authored Aug 2, 2024
1 parent 39598f7 commit c102092
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/web-apps/automated-testing/cypress/yaml/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ npm:
auth: base64SecretToken
username: myUsername
password: myPassword
email: myEmail
email: myEmail
```

---
Expand Down Expand Up @@ -707,7 +707,7 @@ artifacts:
<p><small>| OPTIONAL | OBJECT |</small></p>

Define directories to archive and retain as a test asset at the end of a test run. Archived test assets can
be downloaded automatically using the `download` configuration, via the
be downloaded automatically using the `download` configuration, via the
[REST API](/dev/api/jobs/#get-a-job-asset-file), or through the test details page.

```yaml
Expand Down Expand Up @@ -1231,7 +1231,7 @@ suite:

<p><small>| OPTIONAL | OBJECT |</small></p>

Specifies the retry strategy to apply for that suite. Requires [retries](#retries) to be >= 1.
Specifies the retry strategy. Requires [retries](#retries) to be >= 1.

```yaml
sauce:
Expand All @@ -1242,13 +1242,21 @@ suite:
failedOnly: true
```

:::note
`smartRetry` relies on the Cypress plugin `@cypress/grep` to filter tests.
Ensure that the plugin is installed and configured. Please refer to our
[example repository](https://github.com/saucelabs/saucectl-cypress-example/tree/f8715d05d3f47bb033fbcb2d1086ef970dcb3030/v1/examples/cypress-grep)
for more information.
:::

---

#### `failedOnly`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

When set to `true`, only the tests that failed during the previous attempt are retried.
When set to `true`, only the tests that failed during the previous attempt are
retried.

```yaml
suite:
Expand Down

0 comments on commit c102092

Please sign in to comment.