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.

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

docs: elaborate on smartRetry requirements for cypress #2875

Merged
merged 3 commits into from
Aug 2, 2024
Merged

docs: elaborate on smartRetry requirements for cypress #2875

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a07a9a
docs: elaborate on smartRetry requirements
alexplischke Aug 2, 2024
3539db9
docs: too wordy
alexplischke Aug 2, 2024
c382bcc
Merge branch 'main' into DEVX-2980
alexplischke Aug 2, 2024
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
16 changes: 12 additions & 4 deletions docs/web-apps/automated-testing/cypress/yaml/v1.md
View file
Open in desktop
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
Loading