Document allAttempts feature (#2893)

saucelabs · Aug 16, 2024 · 84a82ef · 84a82ef
1 parent de8ecc4
commit 84a82ef
Show file tree

Hide file tree

Showing 5 changed files with 95 additions and 0 deletions.
diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
@@ -784,6 +784,25 @@ artifacts:
 
 ---
 
+#### `allAttempts`
+
+<p><small>| OPTIONAL | BOOLEAN |</small></p>
+
+If you have your tests configured with [retries](#retries), you can set this option to `true` to download artifacts for every attempt. Otherwise, only artifacts of the last attempt
+will be downloaded.
+
+```yaml
+artifacts:
+  download:
+    match:
+      - console.log
+    when: always
+    allAttempts: true
+    directory: ./artifacts/
+```
+
+---
+
 ## `playwright`
 
 <p><small>| REQUIRED | OBJECT |</small></p>

diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md
@@ -812,6 +812,25 @@ artifacts:
 
 ---
 
+#### `allAttempts`
+
+<p><small>| OPTIONAL | BOOLEAN |</small></p>
+
+If you have your tests configured with [retries](#retries), you can set this option to `true` to download artifacts for every attempt. Otherwise, only artifacts of the last attempt
+will be downloaded.
+
+```yaml
+artifacts:
+  download:
+    match:
+      - console.log
+    when: always
+    allAttempts: true
+    directory: ./artifacts/
+```
+
+---
+
 ## `cypress`
 
 <p><small>| REQUIRED | OBJECT |</small></p>

diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md
@@ -788,6 +788,25 @@ artifacts:
 
 ---
 
+#### `allAttempts`
+
+<p><small>| OPTIONAL | BOOLEAN |</small></p>
+
+If you have your tests configured with [retries](#retries), you can set this option to `true` to download artifacts for every attempt. Otherwise, only artifacts of the last attempt
+will be downloaded.
+
+```yaml
+artifacts:
+  download:
+    match:
+      - console.log
+    when: always
+    allAttempts: true
+    directory: ./artifacts/
+```
+
+---
+
 ## `playwright`
 
 <p><small>| REQUIRED | OBJECT |</small></p>

diff --git a/docs/web-apps/automated-testing/replay/yaml.md b/docs/web-apps/automated-testing/replay/yaml.md
@@ -509,6 +509,25 @@ artifacts:
 
 ---
 
+#### `allAttempts`
+
+<p><small>| OPTIONAL | BOOLEAN |</small></p>
+
+If you have your tests configured with [retries](#retries), you can set this option to `true` to download artifacts for every attempt. Otherwise, only artifacts of the last attempt
+will be downloaded.
+
+```yaml
+artifacts:
+  download:
+    match:
+      - console.log
+    when: always
+    allAttempts: true
+    directory: ./artifacts/
+```
+
+---
+
 ## `suites`
 
 <p><small>| REQUIRED | OBJECT |</small></p>

diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md
@@ -792,6 +792,25 @@ artifacts:
 
 ---
 
+#### `allAttempts`
+
+<p><small>| OPTIONAL | BOOLEAN |</small></p>
+
+If you have your tests configured with [retries](#retries), you can set this option to `true` to download artifacts for every attempt. Otherwise, only artifacts of the last attempt
+will be downloaded.
+
+```yaml
+artifacts:
+  download:
+    match:
+      - console.log
+    when: always
+    allAttempts: true
+    directory: ./artifacts/
+```
+
+---
+
 ## `testcafe`
 
 <p><small>| REQUIRED | OBJECT |</small></p>