Skip to content

Commit 0e3d83d

Browse files
tianfeng92mhan83
tianfeng92
and
mhan83
authored
docs: Support setting global node runtime (#2930)
* docs: Support setting global node runtime * revise notes * fix toc cypress advanced page * apply suggestions from linter * Update docs/web-apps/automated-testing/_partials/_advanced-nodejs.md Co-authored-by: Mike Han <[email protected]> * Update docs/web-apps/automated-testing/_partials/_advanced-nodejs.md Co-authored-by: Mike Han <[email protected]> * Update docs/web-apps/automated-testing/_partials/_advanced-nodejs.md Co-authored-by: Mike Han <[email protected]> * add extra column to display configurable Node.js --------- Co-authored-by: Mike Han <[email protected]>
1 parent d4ea712 commit 0e3d83d

File tree

12 files changed

+160
-13
lines changed

12 files changed

+160
-13
lines changed

‎docs/web-apps/automated-testing/_partials/_advanced-nodejs.md

+31
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, you can specify a 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.
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</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

+3-1
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

+19
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

+15-3
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,16 @@ Sauce Labs supports the following test configurations for Cypress:
3030
<tr>
3131
<th>Cypress Version</th>
3232
<th>Node.js Version</th>
33-
<th>Supported Platforms</th>
34-
<th>Supported Browsers</th>
35-
<th>End of Life</th>
33+
<th width="10%">Supports Configurable Node.js</th>
34+
<th width="20%">Supported Platforms</th>
35+
<th width="30%">Supported Browsers</th>
36+
<th width="30%">End of Life</th>
3637
</tr>
3738
<tbody>
3839
<tr>
3940
<td rowspan='2'>13.13.3</td>
4041
<td rowspan='2'>20</td>
42+
<td rowspan='2'>✅</td>
4143
<td><b>macOS:</b> 11.00, 12, 13</td>
4244
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
4345
<td rowspan='2'>August 28, 2025</td>
@@ -50,6 +52,7 @@ Sauce Labs supports the following test configurations for Cypress:
5052
<tr>
5153
<td rowspan='2'>13.13.1</td>
5254
<td rowspan='2'>20</td>
55+
<td rowspan='2'></td>
5356
<td><b>macOS:</b> 11.00, 12, 13</td>
5457
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
5558
<td rowspan='2'>July 23, 2025</td>
@@ -62,6 +65,7 @@ Sauce Labs supports the following test configurations for Cypress:
6265
<tr>
6366
<td rowspan='2'>13.12.0</td>
6467
<td rowspan='2'>20</td>
68+
<td rowspan='2'></td>
6569
<td><b>macOS:</b> 11.00, 12, 13</td>
6670
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
6771
<td rowspan='2'>June 26, 2025</td>
@@ -74,6 +78,7 @@ Sauce Labs supports the following test configurations for Cypress:
7478
<tr>
7579
<td rowspan='2'>13.10.0</td>
7680
<td rowspan='2'>20</td>
81+
<td rowspan='2'></td>
7782
<td><b>macOS:</b> 11.00, 12, 13</td>
7883
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
7984
<td rowspan='2'>May 28, 2025</td>
@@ -86,6 +91,7 @@ Sauce Labs supports the following test configurations for Cypress:
8691
<tr>
8792
<td rowspan='2'>13.7.3</td>
8893
<td rowspan='2'>20</td>
94+
<td rowspan='2'></td>
8995
<td><b>macOS:</b> 11.00, 12, 13</td>
9096
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
9197
<td rowspan='2'>April 15, 2025</td>
@@ -98,6 +104,7 @@ Sauce Labs supports the following test configurations for Cypress:
98104
<tr>
99105
<td rowspan='2'>13.6.6</td>
100106
<td rowspan='2'>20</td>
107+
<td rowspan='2'></td>
101108
<td><b>macOS:</b> 11.00, 12, 13</td>
102109
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
103110
<td rowspan='2'>February 28, 2025</td>
@@ -110,6 +117,7 @@ Sauce Labs supports the following test configurations for Cypress:
110117
<tr>
111118
<td rowspan='2'>13.6.3</td>
112119
<td rowspan='2'>20</td>
120+
<td rowspan='2'></td>
113121
<td><b>macOS:</b> 11.00, 12, 13</td>
114122
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
115123
<td rowspan='2'>January 22, 2025</td>
@@ -122,6 +130,7 @@ Sauce Labs supports the following test configurations for Cypress:
122130
<tr>
123131
<td rowspan='2'>13.6.0</td>
124132
<td rowspan='2'>20</td>
133+
<td rowspan='2'></td>
125134
<td><b>macOS:</b> 11.00, 12, 13</td>
126135
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
127136
<td rowspan='2'>December 6, 2024</td>
@@ -134,6 +143,7 @@ Sauce Labs supports the following test configurations for Cypress:
134143
<tr>
135144
<td rowspan='2'>13.4.0</td>
136145
<td rowspan='2'>20</td>
146+
<td rowspan='2'></td>
137147
<td><b>macOS:</b> 11.00, 12, 13</td>
138148
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
139149
<td rowspan='2'>November 7, 2024</td>
@@ -146,6 +156,7 @@ Sauce Labs supports the following test configurations for Cypress:
146156
<tr>
147157
<td rowspan='2'>13.3.0</td>
148158
<td rowspan='2'>18</td>
159+
<td rowspan='2'></td>
149160
<td><b>macOS:</b> 11.00, 12, 13</td>
150161
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
151162
<td rowspan='2'>September 28, 2024</td>
@@ -158,6 +169,7 @@ Sauce Labs supports the following test configurations for Cypress:
158169
<tr>
159170
<td rowspan='2'>12.17.4</td>
160171
<td rowspan='2'>18</td>
172+
<td rowspan='2'></td>
161173
<td><b>macOS:</b> 11.00, 12, 13</td>
162174
<td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
163175
<td rowspan='2'>August 31, 2024</td>

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

+3-1
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

+19
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

+15-3
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,16 @@ Sauce Labs supports the following test configurations for Playwright:
3131
<tr>
3232
<th>Playwright Version</th>
3333
<th>Node.js Version</th>
34-
<th>Supported Platforms</th>
35-
<th>Supported Browsers</th>
36-
<th>End of Life</th>
34+
<th width="10%">Supports Configurable Node.js</th>
35+
<th width="20%">Supported Platforms</th>
36+
<th width="30%">Supported Browsers</th>
37+
<th width="30%">End of Life</th>
3738
</tr>
3839
<tbody>
3940
<tr>
4041
<td rowspan='2'>1.46.1</td>
4142
<td rowspan='2'>20</td>
43+
<td rowspan='2'>✅</td>
4244
<td><b>macOS:</b> 12, 13</td>
4345
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
4446
<td rowspan='2'>August 28, 2025</td>
@@ -51,6 +53,7 @@ Sauce Labs supports the following test configurations for Playwright:
5153
<tr>
5254
<td rowspan='2'>1.45.2</td>
5355
<td rowspan='2'>20</td>
56+
<td rowspan='2'></td>
5457
<td><b>macOS:</b> 12, 13</td>
5558
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
5659
<td rowspan='2'>July 23, 2025</td>
@@ -63,6 +66,7 @@ Sauce Labs supports the following test configurations for Playwright:
6366
<tr>
6467
<td rowspan='2'>1.45.0</td>
6568
<td rowspan='2'>20</td>
69+
<td rowspan='2'></td>
6670
<td><b>macOS:</b> 12, 13</td>
6771
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
6872
<td rowspan='2'>June 26, 2025</td>
@@ -75,6 +79,7 @@ Sauce Labs supports the following test configurations for Playwright:
7579
<tr>
7680
<td rowspan='2'>1.44.0</td>
7781
<td rowspan='2'>20</td>
82+
<td rowspan='2'></td>
7883
<td><b>macOS:</b> 12, 13</td>
7984
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
8085
<td rowspan='2'>May 28, 2025</td>
@@ -87,6 +92,7 @@ Sauce Labs supports the following test configurations for Playwright:
8792
<tr>
8893
<td rowspan='2'>1.43.1</td>
8994
<td rowspan='2'>20</td>
95+
<td rowspan='2'></td>
9096
<td><b>macOS:</b> 11.00, 12, 13</td>
9197
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
9298
<td rowspan='2'>April 15, 2025</td>
@@ -99,6 +105,7 @@ Sauce Labs supports the following test configurations for Playwright:
99105
<tr>
100106
<td rowspan='2'>1.41.2</td>
101107
<td rowspan='2'>20</td>
108+
<td rowspan='2'></td>
102109
<td><b>macOS:</b> 11.00, 12, 13</td>
103110
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
104111
<td rowspan='2'>February 28, 2025</td>
@@ -111,6 +118,7 @@ Sauce Labs supports the following test configurations for Playwright:
111118
<tr>
112119
<td rowspan='2'>1.41.0</td>
113120
<td rowspan='2'>20</td>
121+
<td rowspan='2'></td>
114122
<td><b>macOS:</b> 11.00, 12, 13</td>
115123
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
116124
<td rowspan='2'>January 22, 2025</td>
@@ -123,6 +131,7 @@ Sauce Labs supports the following test configurations for Playwright:
123131
<tr>
124132
<td rowspan='2'>1.40.1</td>
125133
<td rowspan='2'>20</td>
134+
<td rowspan='2'></td>
126135
<td><b>macOS:</b> 11.00, 12, 13</td>
127136
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
128137
<td rowspan='2'>December 6, 2024</td>
@@ -135,6 +144,7 @@ Sauce Labs supports the following test configurations for Playwright:
135144
<tr>
136145
<td rowspan='2'>1.39.0</td>
137146
<td rowspan='2'>20</td>
147+
<td rowspan='2'></td>
138148
<td><b>macOS:</b> 11.00, 12, 13</td>
139149
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
140150
<td rowspan='2'>November 7, 2024</td>
@@ -147,6 +157,7 @@ Sauce Labs supports the following test configurations for Playwright:
147157
<tr>
148158
<td rowspan='2'>1.38.1</td>
149159
<td rowspan='2'>18</td>
160+
<td rowspan='2'></td>
150161
<td><b>macOS:</b> 11.00, 12, 13</td>
151162
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
152163
<td rowspan='2'>September 28, 2024</td>
@@ -159,6 +170,7 @@ Sauce Labs supports the following test configurations for Playwright:
159170
<tr>
160171
<td rowspan='2'>1.37.1</td>
161172
<td rowspan='2'>18</td>
173+
<td rowspan='2'></td>
162174
<td><b>macOS:</b> 11.00, 12, 13</td>
163175
<td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
164176
<td rowspan='2'>August 31, 2024</td>

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

+3-1
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

+19
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>

0 commit comments

Comments
 (0)