From c570d2b7a73983da5ff1dccedf2bc01d3b5a4ea3 Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Thu, 8 Aug 2024 17:07:11 -0700 Subject: [PATCH 1/7] docs: Add npm strictSSL field --- .../cucumberjs-playwright/yaml.md | 38 +++++++++++++++++++ .../automated-testing/cypress/yaml/v1.md | 18 +++++++++ .../automated-testing/playwright/yaml.md | 18 +++++++++ .../automated-testing/testcafe/yaml.md | 18 +++++++++ 4 files changed, 92 insertions(+) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 58d53b70d7..3df16dab7c 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -349,6 +349,7 @@ A parent property specifying the configuration details for any `npm` dependencie ```yaml npm: + strictSSL: true registry: https://registry.npmjs.org registries: - url: https://registry.npmjs.org @@ -530,6 +531,43 @@ To use this feature, make sure that `node_modules` is not ignored via `.sauceign --- +### `packages` + +

| OPTIONAL | OBJECT |

+ +Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](#including-node-dependencies). + +```yaml +npm: + packages: + lodash: "4.17.20" + "@babel/preset-typescript": "7.12" +``` + +:::caution +Do not use `dependencies` and `packages` at the same time. +::: + +--- + +### `strictSSL` + +

| OPTIONAL | BOOLEAN |

+ +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. + +:::note +When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +::: + +```yaml +npm: + strictSSL: false + package: + "lodash": "4.17.20" +``` +--- + ## `reporters`

| OPTIONAL | OBJECT |

diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index b1340101ed..5ed63148f4 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -563,6 +563,24 @@ Do not use `dependencies` and `packages` at the same time. --- +### `strictSSL` + +

| OPTIONAL | BOOLEAN |

+ +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. + +:::note +When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +::: + +```yaml +npm: + strictSSL: false + package: + "lodash": "4.17.20" +``` +--- + ## `reporters`

| OPTIONAL | OBJECT |

diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index 7f1f2ed3ed..aade5d96d9 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -542,6 +542,24 @@ Do not use `dependencies` and `packages` at the same time. --- +### `strictSSL` + +

| OPTIONAL | BOOLEAN |

+ +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. + +:::note +When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +::: + +```yaml +npm: + strictSSL: false + package: + "lodash": "4.17.20" +``` +--- + ## `reporters`

| OPTIONAL | OBJECT |

diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index 1bc724b67e..c3cbf079d9 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -546,6 +546,24 @@ Do not use `dependencies` and `packages` at the same time. --- +### `strictSSL` + +

| OPTIONAL | BOOLEAN |

+ +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. + +:::note +When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +::: + +```yaml +npm: + strictSSL: false + package: + "lodash": "4.17.20" +``` +--- + ## `reporters`

| OPTIONAL | OBJECT |

From 176daffb65edfd297d7fef731f59bdfede92f536 Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Thu, 8 Aug 2024 23:33:08 -0700 Subject: [PATCH 2/7] complete npm config examples --- docs/web-apps/automated-testing/cypress/yaml/v1.md | 1 + docs/web-apps/automated-testing/playwright/yaml.md | 1 + docs/web-apps/automated-testing/testcafe/yaml.md | 1 + 3 files changed, 3 insertions(+) diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 5ed63148f4..54ee9dc94b 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -360,6 +360,7 @@ A parent property specifying the configuration details for any `npm` dependencie ```yaml npm: + strictSSL: true registry: https://registry.npmjs.org registries: - url: https://registry.npmjs.org diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index aade5d96d9..eae71fd29c 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -343,6 +343,7 @@ A parent property specifying the configuration details for any `npm` dependencie ```yaml npm: + strictSSL: true registry: https://registry.npmjs.org registries: - url: https://registry.npmjs.org diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index c3cbf079d9..99aa417906 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -343,6 +343,7 @@ A parent property specifying the configuration details for any `npm` dependencie ```yaml npm: + strictSSL: true registry: https://registry.npmjs.org registries: - url: https://registry.npmjs.org From ae536817fd08fad712e8d22ef8098c8e0e1dacf8 Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Fri, 9 Aug 2024 09:43:36 -0700 Subject: [PATCH 3/7] correct default value --- docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md | 2 +- docs/web-apps/automated-testing/cypress/yaml/v1.md | 2 +- docs/web-apps/automated-testing/playwright/yaml.md | 2 +- docs/web-apps/automated-testing/testcafe/yaml.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 3df16dab7c..5f3d33c0b1 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -554,7 +554,7 @@ Do not use `dependencies` and `packages` at the same time.

| OPTIONAL | BOOLEAN |

-Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 54ee9dc94b..027c349fb3 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -568,7 +568,7 @@ Do not use `dependencies` and `packages` at the same time.

| OPTIONAL | BOOLEAN |

-Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index eae71fd29c..f214a0c32d 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -547,7 +547,7 @@ Do not use `dependencies` and `packages` at the same time.

| OPTIONAL | BOOLEAN |

-Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index 99aa417906..3c7974cd64 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -551,7 +551,7 @@ Do not use `dependencies` and `packages` at the same time.

| OPTIONAL | BOOLEAN |

-Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `true` if not set. +Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. From 980a4ef8cd58d268928da105ec5a1a8af886c096 Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 12 Aug 2024 10:14:18 -0700 Subject: [PATCH 4/7] Update docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md Co-authored-by: Alex Plischke --- docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 5f3d33c0b1..e9c6fcf016 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -557,7 +557,7 @@ Do not use `dependencies` and `packages` at the same time. Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note -When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`. ::: ```yaml From cba549c11980c8b73a2697f129833fe4a55e567c Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 12 Aug 2024 10:15:14 -0700 Subject: [PATCH 5/7] apply suggestions --- docs/web-apps/automated-testing/cypress/yaml/v1.md | 2 +- docs/web-apps/automated-testing/playwright/yaml.md | 2 +- docs/web-apps/automated-testing/testcafe/yaml.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 027c349fb3..53df6d3971 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -571,7 +571,7 @@ Do not use `dependencies` and `packages` at the same time. Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note -When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`. ::: ```yaml diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index f214a0c32d..f130d67ec7 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -550,7 +550,7 @@ Do not use `dependencies` and `packages` at the same time. Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note -When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`. ::: ```yaml diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index 3c7974cd64..a90b7d7d0d 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -554,7 +554,7 @@ Do not use `dependencies` and `packages` at the same time. Instructs npm to perform SSL key validation when making requests to the registry via HTTPS (`true`) or not (`false`). Defaults to `false` if not set. :::note -When running tests and installing packages via a Sauce Connect tunnel, it is required to set `strictSSL` to `false`. +If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`. ::: ```yaml From a6e10a28fc6f2e5ec0c359393b1604f7e8dec1db Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 12 Aug 2024 10:21:13 -0700 Subject: [PATCH 6/7] fix broken links --- docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md | 2 +- docs/web-apps/automated-testing/cypress/yaml/v1.md | 2 +- docs/web-apps/automated-testing/playwright/yaml.md | 2 +- docs/web-apps/automated-testing/testcafe/yaml.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index e9c6fcf016..c2a95d3dc6 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -535,7 +535,7 @@ To use this feature, make sure that `node_modules` is not ignored via `.sauceign

| OPTIONAL | OBJECT |

-Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](#including-node-dependencies). +Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](advanced.md#including-node-dependencies). ```yaml npm: diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 53df6d3971..49b67c5b9b 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -519,7 +519,7 @@ npm:

| OPTIONAL | OBJECT |

-Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](#including-node-dependencies). +Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](advanced.md#including-node-dependencies). ```yaml npm: diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md index f130d67ec7..79197e0e72 100644 --- a/docs/web-apps/automated-testing/playwright/yaml.md +++ b/docs/web-apps/automated-testing/playwright/yaml.md @@ -500,7 +500,7 @@ npm:

| OPTIONAL | OBJECT |

-Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](#including-node-dependencies). +Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](advanced.md#including-node-dependencies). ```yaml npm: diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md index a90b7d7d0d..0e8342575f 100644 --- a/docs/web-apps/automated-testing/testcafe/yaml.md +++ b/docs/web-apps/automated-testing/testcafe/yaml.md @@ -502,7 +502,7 @@ npm:

| OPTIONAL | OBJECT |

-Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](#including-node-dependencies). +Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](advanced.md#including-node-dependencies). ```yaml npm: From eedb75e3b79e6c75037db7c212693a13527477c2 Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 12 Aug 2024 10:22:25 -0700 Subject: [PATCH 7/7] fix link for cypress --- docs/web-apps/automated-testing/cypress/yaml/v1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md index 49b67c5b9b..61abd579ad 100644 --- a/docs/web-apps/automated-testing/cypress/yaml/v1.md +++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md @@ -519,7 +519,7 @@ npm:

| OPTIONAL | OBJECT |

-Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](advanced.md#including-node-dependencies). +Specifies any npm packages that are required to run tests and should, therefore, be installed on the Sauce Labs VM. See [Including Node Dependencies](../advanced.md#including-node-dependencies). ```yaml npm: