Skip to content

Commit 156a5ff

Browse files
committed
docs: Support setting global node runtime
1 parent d4ea712 commit 156a5ff

File tree

12 files changed

+122
-7
lines changed

12 files changed

+122
-7
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Using Node.js Runtime on Sauce Cloud
2+
3+
Since `saucectl` v0.185.0 and above, you can specify Node.js runtime version on Sauce Cloud.
4+
5+
Only supported test runners can use configurable Node.js versions. Check the following pages for supported framework versions that allow configurable Node.js versions.
6+
7+
- [Cypress](../cypress.md#supported-testing-platforms)
8+
- [Playwright](../playwright.md#supported-testing-platforms)
9+
- [Playwright-Cucumber](../playwright.md#supported-testing-platforms)
10+
- [TestCafe](../testcafe.md#supported-testing-platforms)
11+
12+
### Supported Node.js versions
13+
14+
Sauce Labs supports the following Node.js versions:
15+
16+
<table id="table-nodejs">
17+
<tr>
18+
<th>Node.js Version</th>
19+
<th>Alias Name</th>
20+
<th>End of Life</th>
21+
<th>Removal Date</th>
22+
</tr>
23+
<tbody>
24+
<tr>
25+
<td>20.14.0</td>
26+
<td>iron, lts</td>
27+
<td>October 22, 2024</td>
28+
<td>April 30, 2026</td>
29+
</tr>
30+
</tbody>
31+
</table>

docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ import TabItem from '@theme/TabItem';
99
import useBaseUrl from '@docusaurus/useBaseUrl';
1010
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
1111
import AdvancedPlaywrightCucumber, {toc as AdvancedPlaywrightCucumberTOC} from '../\_partials/\_advanced-playwright-cucumber.md';
12+
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';
1213

14+
<AdvancedNodejs />
1315
<AdvancedPlaywrightCucumber />
1416
<Advanced />
1517

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

18-
export const toc = [...AdvancedPlaywrightCucumberTOC, ...AdvancedTOC];
20+
export const toc = [...AdvancedNodejsTOC, ...AdvancedPlaywrightCucumberTOC, ...AdvancedTOC];

docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,25 @@ kind: playwright-cucumberjs
5656

5757
---
5858

59+
## `nodeVersion`
60+
61+
<p><small>| OPTIONAL | STRING |</small></p>
62+
63+
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).
64+
65+
Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.
66+
67+
:::note
68+
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).
69+
70+
:::
71+
72+
```yaml
73+
nodeVersion: v20
74+
```
75+
76+
---
77+
5978
## `showConsoleLog`
6079

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

docs/web-apps/automated-testing/cypress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Sauce Labs supports the following test configurations for Cypress:
3737
<tbody>
3838
<tr>
3939
<td rowspan='2'>13.13.3</td>
40-
<td rowspan='2'>20</td>
40+
<td rowspan='2'>20, Version Configurable</td>
4141
<td><b>macOS:</b> 11.00, 12, 13</td>
4242
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
4343
<td rowspan='2'>August 28, 2025</td>

docs/web-apps/automated-testing/cypress/advanced.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ import TabItem from '@theme/TabItem';
99
import useBaseUrl from '@docusaurus/useBaseUrl';
1010
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
1111
import AdvancedCypress, {toc as AdvancedCypressTOC} from '../\_partials/\_advanced-cypress.md';
12+
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';
1213

14+
<AdvancedNodejs />
1315
<Advanced />
1416
<AdvancedCypress />
1517

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

18-
export const toc = [...AdvancedTOC, ...AdvancedCypressTOC];
20+
export const toc = [AdvancedNodejsTOC, ...AdvancedTOC, ...AdvancedCypressTOC];

docs/web-apps/automated-testing/cypress/yaml/v1.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,25 @@ kind: cypress
6666

6767
---
6868

69+
## `nodeVersion`
70+
71+
<p><small>| OPTIONAL | STRING |</small></p>
72+
73+
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).
74+
75+
Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.
76+
77+
:::note
78+
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).
79+
80+
:::
81+
82+
```yaml
83+
nodeVersion: v20
84+
```
85+
86+
---
87+
6988
## `showConsoleLog`
7089

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

docs/web-apps/automated-testing/playwright.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Sauce Labs supports the following test configurations for Playwright:
3838
<tbody>
3939
<tr>
4040
<td rowspan='2'>1.46.1</td>
41-
<td rowspan='2'>20</td>
41+
<td rowspan='2'>20, Version Configurable</td>
4242
<td><b>macOS:</b> 12, 13</td>
4343
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
4444
<td rowspan='2'>August 28, 2025</td>

docs/web-apps/automated-testing/playwright/advanced.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ import TabItem from '@theme/TabItem';
99
import useBaseUrl from '@docusaurus/useBaseUrl';
1010
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
1111
import AdvancedPlaywright, {toc as AdvancedPlaywrightTOC} from '../\_partials/\_advanced-playwright.md';
12+
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';
1213

14+
<AdvancedNodejs />
1315
<Advanced />
1416
<AdvancedPlaywright />
1517

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

18-
export const toc = [...AdvancedTOC, ...AdvancedPlaywrightTOC];
20+
export const toc = [...AdvancedNodejsTOC, ...AdvancedTOC, ...AdvancedPlaywrightTOC];

docs/web-apps/automated-testing/playwright/yaml.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,25 @@ kind: playwright
5656

5757
---
5858

59+
## `nodeVersion`
60+
61+
<p><small>| OPTIONAL | STRING |</small></p>
62+
63+
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).
64+
65+
Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.
66+
67+
:::note
68+
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).
69+
70+
:::
71+
72+
```yaml
73+
nodeVersion: v20
74+
```
75+
76+
---
77+
5978
## `showConsoleLog`
6079

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

docs/web-apps/automated-testing/testcafe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Sauce Labs supports the following test configurations for TestCafe:
3737
<tbody>
3838
<tr>
3939
<td rowspan='3'>3.6.2</td>
40-
<td rowspan='3'>20</td>
40+
<td rowspan='3'>20, Version Configurable</td>
4141
<td><b>macOS:</b> 11.00, 12, 13</td>
4242
<td>Safari, Chrome, Firefox, Microsoft Edge</td>
4343
<td rowspan='3'>August 28, 2025</td>

docs/web-apps/automated-testing/testcafe/advanced.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ import Tabs from '@theme/Tabs';
88
import TabItem from '@theme/TabItem';
99
import useBaseUrl from '@docusaurus/useBaseUrl';
1010
import Advanced, {toc as AdvancedTOC} from '../\_partials/\_advanced.md';
11+
import AdvancedNodejs, {toc as AdvancedNodejsTOC} from '../\_partials/\_advanced-nodejs.md';
1112

13+
<AdvancedNodejs />
1214
<Advanced />
1315

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

16-
export const toc = [...AdvancedTOC];
18+
export const toc = [...AdvancedNodejsTOC, ...AdvancedTOC];

docs/web-apps/automated-testing/testcafe/yaml.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,25 @@ kind: testcafe
5656

5757
---
5858

59+
## `nodeVersion`
60+
61+
<p><small>| OPTIONAL | STRING |</small></p>
62+
63+
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).
64+
65+
Examples: `v20`, `v20.14.0`, `v20.14`, `iron`, `lts`.
66+
67+
:::note
68+
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).
69+
70+
:::
71+
72+
```yaml
73+
nodeVersion: v20
74+
```
75+
76+
---
77+
5978
## `showConsoleLog`
6079

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

0 commit comments

Comments
 (0)