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: Add npm strictSSL field #2882

Merged
merged 8 commits into from
Aug 12, 2024
Merged

docs: Add npm strictSSL field #2882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c570d2b
docs: Add npm strictSSL field
tianfeng92 Aug 9, 2024
176daff
complete npm config examples
tianfeng92 Aug 9, 2024
ae53681
correct default value
tianfeng92 Aug 9, 2024
433a711
Merge branch 'main' into DEVX-3001
tianfeng92 Aug 12, 2024
980a4ef
Update docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
tianfeng92 Aug 12, 2024
cba549c
apply suggestions
tianfeng92 Aug 12, 2024
a6e10a2
fix broken links
tianfeng92 Aug 12, 2024
eedb75e
fix link for cypress
tianfeng92 Aug 12, 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
38 changes: 38 additions & 0 deletions docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -530,6 +531,43 @@ To use this feature, make sure that `node_modules` is not ignored via `.sauceign

---

### `packages`

<p><small>| OPTIONAL | OBJECT |</small></p>

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:
packages:
lodash: "4.17.20"
"@babel/preset-typescript": "7.12"
```

:::caution
Do not use `dependencies` and `packages` at the same time.
:::

---

### `strictSSL`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

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
If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`.
:::

```yaml
npm:
strictSSL: false
package:
"lodash": "4.17.20"
```
---

## `reporters`

<p><small>| OPTIONAL | OBJECT |</small></p>
Expand Down
21 changes: 20 additions & 1 deletion 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 @@ -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
Expand Down Expand Up @@ -518,7 +519,7 @@ npm:

<p><small>| OPTIONAL | OBJECT |</small></p>

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:
Expand Down Expand Up @@ -563,6 +564,24 @@ Do not use `dependencies` and `packages` at the same time.

---

### `strictSSL`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

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
If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`.
:::

```yaml
npm:
strictSSL: false
package:
"lodash": "4.17.20"
```
---

## `reporters`

<p><small>| OPTIONAL | OBJECT |</small></p>
Expand Down
21 changes: 20 additions & 1 deletion docs/web-apps/automated-testing/playwright/yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -499,7 +500,7 @@ npm:

<p><small>| OPTIONAL | OBJECT |</small></p>

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:
Expand Down Expand Up @@ -542,6 +543,24 @@ Do not use `dependencies` and `packages` at the same time.

---

### `strictSSL`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

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
If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`.
:::

```yaml
npm:
strictSSL: false
package:
"lodash": "4.17.20"
```
---

## `reporters`

<p><small>| OPTIONAL | OBJECT |</small></p>
Expand Down
21 changes: 20 additions & 1 deletion docs/web-apps/automated-testing/testcafe/yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -501,7 +502,7 @@ npm:

<p><small>| OPTIONAL | OBJECT |</small></p>

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:
Expand Down Expand Up @@ -546,6 +547,24 @@ Do not use `dependencies` and `packages` at the same time.

---

### `strictSSL`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

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
If you're using a Sauce Connect tunnel, you must set `strictSSL` to `false`.
:::

```yaml
npm:
strictSSL: false
package:
"lodash": "4.17.20"
```
---

## `reporters`

<p><small>| OPTIONAL | OBJECT |</small></p>
Expand Down
Loading