Skip to content

Commit

Permalink
docs: Support setting global node runtime
Browse files Browse the repository at this point in the history
  • Loading branch information
tianfeng92 committed Sep 9, 2024
1 parent d4ea712 commit 156a5ff
Show file tree
Hide file tree
Showing 12 changed files with 122 additions and 7 deletions.
31 changes: 31 additions & 0 deletions docs/web-apps/automated-testing/_partials/_advanced-nodejs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Using Node.js Runtime on Sauce Cloud

Since `saucectl` v0.185.0 and above, you can specify Node.js runtime version on Sauce Cloud.

Only supported test runners can use configurable Node.js versions. Check the following pages for supported framework versions that allow configurable Node.js versions.

- [Cypress](../cypress.md#supported-testing-platforms)
- [Playwright](../playwright.md#supported-testing-platforms)
- [Playwright-Cucumber](../playwright.md#supported-testing-platforms)
- [TestCafe](../testcafe.md#supported-testing-platforms)

### Supported Node.js versions

Check warning on line 12 in docs/web-apps/automated-testing/_partials/_advanced-nodejs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/_partials/_advanced-nodejs.md#L12

[sauce.Headings] 'Supported Node.js versions' should use title case capitalization.
Raw output
{"message": "[sauce.Headings] 'Supported Node.js versions' should use title case capitalization.", "location": {"path": "docs/web-apps/automated-testing/_partials/_advanced-nodejs.md", "range": {"start": {"line": 12, "column": 5}}}, "severity": "WARNING"}

Sauce Labs supports the following Node.js versions:

<table id="table-nodejs">
<tr>
<th>Node.js Version</th>
<th>Alias Name</th>
<th>End of Life</th>
<th>Removal Date</th>
</tr>
<tbody>
<tr>
<td>20.14.0</td>
<td>iron, lts</td>
<td>October 22, 2024</td>
<td>April 30, 2026</td>
</tr>
</tbody>
</table>
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
import AdvancedPlaywrightCucumber, {toc as AdvancedPlaywrightCucumberTOC} from '../\_partials/\_advanced-playwright-cucumber.md';
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';

<AdvancedNodejs />
<AdvancedPlaywrightCucumber />
<Advanced />

<!-- Using partials breaks table of contents. Using this workaround to get it working again. -->

export const toc = [...AdvancedPlaywrightCucumberTOC, ...AdvancedTOC];
export const toc = [...AdvancedNodejsTOC, ...AdvancedPlaywrightCucumberTOC, ...AdvancedTOC];

Check warning on line 20 in docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md", "range": {"start": {"line": 20, "column": 21}}}, "severity": "WARNING"}

Check warning on line 20 in docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md", "range": {"start": {"line": 20, "column": 43}}}, "severity": "WARNING"}

Check warning on line 20 in docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md", "range": {"start": {"line": 20, "column": 77}}}, "severity": "WARNING"}
19 changes: 19 additions & 0 deletions docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,25 @@ kind: playwright-cucumberjs

---

## `nodeVersion`

<p><small>| OPTIONAL | STRING |</small></p>

Specifies the Node.js version for Sauce Cloud, supporting SemVer notation and aliases. For more details, refer to the [Advanced Configuration Page](./advanced.md#using-nodejs-runtime-on-sauce-cloud).

Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.

:::note
This feature is available in `saucectl` version v0.185.0+ and supported test runners. For details on supported test runners, see [Supported Testing Platforms](../playwright.md#supported-testing-platforms).

:::

```yaml
nodeVersion: v20
```

---

## `showConsoleLog`

<p><small>| OPTIONAL | BOOLEAN |</small></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/web-apps/automated-testing/cypress.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Sauce Labs supports the following test configurations for Cypress:
<tbody>
<tr>
<td rowspan='2'>13.13.3</td>
<td rowspan='2'>20</td>
<td rowspan='2'>20, Version Configurable</td>
<td><b>macOS:</b> 11.00, 12, 13</td>
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
<td rowspan='2'>August 28, 2025</td>
Expand Down
4 changes: 3 additions & 1 deletion docs/web-apps/automated-testing/cypress/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
import AdvancedCypress, {toc as AdvancedCypressTOC} from '../\_partials/\_advanced-cypress.md';
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';

<AdvancedNodejs />
<Advanced />
<AdvancedCypress />

<!-- Using partials breaks table of contents. Using this workaround to get it working again. -->

export const toc = [...AdvancedTOC, ...AdvancedCypressTOC];
export const toc = [AdvancedNodejsTOC, ...AdvancedTOC, ...AdvancedCypressTOC];

Check warning on line 20 in docs/web-apps/automated-testing/cypress/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/cypress/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/cypress/advanced.md", "range": {"start": {"line": 20, "column": 40}}}, "severity": "WARNING"}

Check warning on line 20 in docs/web-apps/automated-testing/cypress/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/cypress/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/cypress/advanced.md", "range": {"start": {"line": 20, "column": 56}}}, "severity": "WARNING"}
19 changes: 19 additions & 0 deletions docs/web-apps/automated-testing/cypress/yaml/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,25 @@ kind: cypress

---

## `nodeVersion`

<p><small>| OPTIONAL | STRING |</small></p>

Specifies the Node.js version for Sauce Cloud, supporting SemVer notation and aliases. For more details, refer to the [Advanced Configuration Page](../advanced.md#using-nodejs-runtime-on-sauce-cloud).

Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.

:::note
This feature is available in `saucectl` version v0.185.0+ and supported test runners. For details on supported test runners, see [Supported Testing Platforms](../../cypress.md#supported-testing-platforms).

:::

```yaml
nodeVersion: v20
```

---

## `showConsoleLog`

<p><small>| OPTIONAL | BOOLEAN |</small></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/web-apps/automated-testing/playwright.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Sauce Labs supports the following test configurations for Playwright:
<tbody>
<tr>
<td rowspan='2'>1.46.1</td>
<td rowspan='2'>20</td>
<td rowspan='2'>20, Version Configurable</td>
<td><b>macOS:</b> 12, 13</td>
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
<td rowspan='2'>August 28, 2025</td>
Expand Down
4 changes: 3 additions & 1 deletion docs/web-apps/automated-testing/playwright/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
import AdvancedPlaywright, {toc as AdvancedPlaywrightTOC} from '../\_partials/\_advanced-playwright.md';
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';

<AdvancedNodejs />
<Advanced />
<AdvancedPlaywright />

<!-- Using partials breaks table of contents. Using this workaround to get it working again. -->

export const toc = [...AdvancedTOC, ...AdvancedPlaywrightTOC];
export const toc = [...AdvancedNodejsTOC, ...AdvancedTOC, ...AdvancedPlaywrightTOC];

Check warning on line 20 in docs/web-apps/automated-testing/playwright/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/playwright/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/playwright/advanced.md", "range": {"start": {"line": 20, "column": 21}}}, "severity": "WARNING"}

Check warning on line 20 in docs/web-apps/automated-testing/playwright/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/playwright/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/playwright/advanced.md", "range": {"start": {"line": 20, "column": 43}}}, "severity": "WARNING"}

Check warning on line 20 in docs/web-apps/automated-testing/playwright/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/playwright/advanced.md#L20

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/playwright/advanced.md", "range": {"start": {"line": 20, "column": 59}}}, "severity": "WARNING"}
19 changes: 19 additions & 0 deletions docs/web-apps/automated-testing/playwright/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,25 @@ kind: playwright

---

## `nodeVersion`

<p><small>| OPTIONAL | STRING |</small></p>

Specifies the Node.js version for Sauce Cloud, supporting SemVer notation and aliases. For more details, refer to the [Advanced Configuration Page](./advanced.md#using-nodejs-runtime-on-sauce-cloud).

Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.

:::note
This feature is available in `saucectl` version v0.185.0+ and supported test runners. For details on supported test runners, see [Supported Testing Platforms](../playwright.md#supported-testing-platforms).

:::

```yaml
nodeVersion: v20
```

---

## `showConsoleLog`

<p><small>| OPTIONAL | BOOLEAN |</small></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/web-apps/automated-testing/testcafe.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Sauce Labs supports the following test configurations for TestCafe:
<tbody>
<tr>
<td rowspan='3'>3.6.2</td>
<td rowspan='3'>20</td>
<td rowspan='3'>20, Version Configurable</td>
<td><b>macOS:</b> 11.00, 12, 13</td>
<td>Safari, Chrome, Firefox, Microsoft Edge</td>
<td rowspan='3'>August 28, 2025</td>
Expand Down
4 changes: 3 additions & 1 deletion docs/web-apps/automated-testing/testcafe/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';

<AdvancedNodejs />
<Advanced />

<!-- Using partials breaks table of contents. Using this workaround to get it working again. -->

export const toc = [...AdvancedTOC];
export const toc = [...AdvancedNodejsTOC, ...AdvancedTOC];

Check warning on line 18 in docs/web-apps/automated-testing/testcafe/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/testcafe/advanced.md#L18

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/testcafe/advanced.md", "range": {"start": {"line": 18, "column": 21}}}, "severity": "WARNING"}

Check warning on line 18 in docs/web-apps/automated-testing/testcafe/advanced.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/web-apps/automated-testing/testcafe/advanced.md#L18

[sauce.Ellipses] In general, don't use an ellipsis.
Raw output
{"message": "[sauce.Ellipses] In general, don't use an ellipsis.", "location": {"path": "docs/web-apps/automated-testing/testcafe/advanced.md", "range": {"start": {"line": 18, "column": 43}}}, "severity": "WARNING"}
19 changes: 19 additions & 0 deletions docs/web-apps/automated-testing/testcafe/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,25 @@ kind: testcafe

---

## `nodeVersion`

<p><small>| OPTIONAL | STRING |</small></p>

Specifies the Node.js version for Sauce Cloud, supporting SemVer notation and aliases. For more details, refer to the [Advanced Configuration Page](./advanced.md#using-nodejs-runtime-on-sauce-cloud).

Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.

:::note
This feature is available in `saucectl` version v0.185.0+ and supported test runners. For details on supported test runners, see [Supported Testing Platforms](../testcafe.md#supported-testing-platforms).

:::

```yaml
nodeVersion: v20
```

---

## `showConsoleLog`

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

0 comments on commit 156a5ff

Please sign in to comment.