From 5a07a9a0e95d0749518019d0866c056a084add97 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Fri, 2 Aug 2024 08:07:04 -0700 Subject: [PATCH 1/2] docs: elaborate on smartRetry requirements --- .../automated-testing/cypress/yaml/v1.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 9025048e37..b38a6ab03e 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -404,7 +404,7 @@ npm: auth: base64SecretToken username: myUsername password: myPassword - email: myEmail + email: myEmail ``` --- @@ -707,7 +707,7 @@ artifacts:

| OPTIONAL | OBJECT |

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 @@ -1231,7 +1231,8 @@ suite:

| OPTIONAL | OBJECT |

-Specifies the retry strategy to apply for that suite. Requires [retries](#retries) to be >= 1. +Specifies the retry strategy to apply for that suite. Requires [retries](#retries) +to be >= 1. ```yaml sauce: @@ -1242,13 +1243,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`

| OPTIONAL | BOOLEAN |

-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: From 3539db91bec2f89be0f3ac5348e486b2ab7840d1 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Fri, 2 Aug 2024 08:07:32 -0700 Subject: [PATCH 2/2] docs: too wordy --- docs/web-apps/automated-testing/cypress/yaml/v1.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index b38a6ab03e..b1340101ed 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -1231,8 +1231,7 @@ suite:

| OPTIONAL | OBJECT |

-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: