From 83a6fbb5798c7eca41b3412cc401fb1156a71e47 Mon Sep 17 00:00:00 2001 From: Alex Plischke Date: Wed, 11 Dec 2024 13:10:29 -0800 Subject: [PATCH 1/2] docs: add requirements for the usePackageLock feature (#3046) --- .../automated-testing/cucumberjs-playwright/yaml.md | 6 +++--- docs/web-apps/automated-testing/cypress/yaml/v1.md | 2 +- docs/web-apps/automated-testing/playwright/yaml.md | 6 +++--- docs/web-apps/automated-testing/testcafe/yaml.md | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 3d375d70c3..13713c62e1 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -423,7 +423,7 @@ npm: auth: base64SecretToken username: myUsername password: myPassword - email: myEmail + email: myEmail ``` --- @@ -580,7 +580,7 @@ Do not use `dependencies` and `packages` at the same time. ### `usePackageLock` -

| OPTIONAL | BOOLEAN |

+

| OPTIONAL | BOOLEAN | Playwright 1.48.2+ | saucectl 0.187.0+ |

Specifies whether to use the project's package-lock.json when installing npm dependencies. If true, package-lock.json will be used during package @@ -743,7 +743,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 diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 3e9d206325..2a74e3b2a7 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -565,7 +565,7 @@ Do not use `dependencies` and `packages` at the same time. ### `usePackageLock` -

| OPTIONAL | BOOLEAN |

+

| OPTIONAL | BOOLEAN | Cypress 13.15.1+ | saucectl 0.187.0+ |

Specifies whether to use the project's package-lock.json when installing npm dependencies. If true, package-lock.json will be used during package diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index 06ff96f8b5..e9c36259f3 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -414,7 +414,7 @@ npm: auth: base64SecretToken username: myUsername password: myPassword - email: myEmail + email: myEmail ``` --- @@ -544,7 +544,7 @@ Do not use `dependencies` and `packages` at the same time. ### `usePackageLock` -

| OPTIONAL | BOOLEAN |

+

| OPTIONAL | BOOLEAN | Playwright 1.48.2+ | saucectl 0.187.0+ |

Specifies whether to use the project's package-lock.json when installing npm dependencies. If true, package-lock.json will be used during package @@ -747,7 +747,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 diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index 2261de0461..cb5b704aea 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -416,7 +416,7 @@ npm: auth: base64SecretToken username: myUsername password: myPassword - email: myEmail + email: myEmail ``` --- @@ -548,7 +548,7 @@ Do not use `dependencies` and `packages` at the same time. ### `usePackageLock` -

| OPTIONAL | BOOLEAN |

+

| OPTIONAL | BOOLEAN | TestCafe 3.6.2+ | saucectl 0.187.0+ |

Specifies whether to use the project's package-lock.json when installing npm dependencies. If true, package-lock.json will be used during package @@ -751,7 +751,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 From da746c0d2d9d4a5adeb669a7a42ad996e07b3b0e Mon Sep 17 00:00:00 2001 From: Mike Han <56001373+mhan83@users.noreply.github.com> Date: Wed, 11 Dec 2024 14:14:58 -0700 Subject: [PATCH 2/2] docs: Add description for xcuitest saucectl option "shard: testList" (#3041) * docs: Add description for xcuitest shard: testList * Incorporate lint suggestion --- .../automated-testing/espresso-xcuitest/xcuitest.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md b/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md index 4f2332943f..3b780e2587 100644 --- a/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md +++ b/docs/mobile-apps/automated-testing/espresso-xcuitest/xcuitest.md @@ -1327,12 +1327,18 @@ suites:

| OPTIONAL | STRING |

-When shard is configured as `concurrency`, saucectl automatically splits the tests into several groups (the number of groups is determined by the concurrency setting). Each group will then run as an individual job. +Configures saucectl to automatically split the tests of a suite to run in +parallel. Valid values are `concurrency` and `testList`. -Selectable values: `concurrency` to shard by concurrency. Remove this field or leave it empty `""` for no sharding. +In `concurrency` mode, saucectl automatically splits the tests into several +groups (the number of groups is determined by the concurrency setting). Each +group will then run as an individual job. + +In `testList` mode, saucectl will use the provided [testListFile](#testlistfile) +and run each entry defined there in parallel. :::note -When shard is set for a suite, the [class](#class) setting is automatically ignored. +When sharding is enabled, the [class](#class) setting is automatically ignored. ::: ```yaml