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]>
saucelabs · Sep 10, 2024 · 0e3d83d · 0e3d83d
1 parent d4ea712
commit 0e3d83d
Show file tree

Hide file tree

Showing 12 changed files with 160 additions and 13 deletions.
diff --git a/docs/web-apps/automated-testing/_partials/_advanced-nodejs.md b/docs/web-apps/automated-testing/_partials/_advanced-nodejs.md
@@ -0,0 +1,31 @@
+## Using Node.js Runtime on Sauce Cloud
+
+Since `saucectl` v0.185.0, you can specify a 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.
+
+- [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
+
+Sauce Labs supports the following Node.js versions:
+
+<table id="table-nodejs">
+  <tr>
+    <th>Node.js Version</th>
+    <th>Alias</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>
diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md b/docs/web-apps/automated-testing/cucumberjs-playwright/advanced.md
@@ -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];
diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
@@ -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>

diff --git a/docs/web-apps/automated-testing/cypress.md b/docs/web-apps/automated-testing/cypress.md
@@ -30,14 +30,16 @@ Sauce Labs supports the following test configurations for Cypress:
   <tr>
     <th>Cypress Version</th>
     <th>Node.js Version</th>
-    <th>Supported Platforms</th>
-    <th>Supported Browsers</th>
-    <th>End of Life</th>
+    <th width="10%">Supports Configurable Node.js</th>
+    <th width="20%">Supported Platforms</th>
+    <th width="30%">Supported Browsers</th>
+    <th width="30%">End of Life</th>
   </tr>
   <tbody>
     <tr>
       <td rowspan='2'>13.13.3</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'>✅</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>
@@ -50,6 +52,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.13.1</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>July 23, 2025</td>
@@ -62,6 +65,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.12.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>June 26, 2025</td>
@@ -74,6 +78,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.10.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>May 28, 2025</td>
@@ -86,6 +91,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.7.3</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>April 15, 2025</td>
@@ -98,6 +104,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.6.6</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>February 28, 2025</td>
@@ -110,6 +117,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.6.3</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>January 22, 2025</td>
@@ -122,6 +130,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.6.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>December 6, 2024</td>
@@ -134,6 +143,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.4.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>November 7, 2024</td>
@@ -146,6 +156,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>13.3.0</td>
       <td rowspan='2'>18</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>September 28, 2024</td>
@@ -158,6 +169,7 @@ Sauce Labs supports the following test configurations for Cypress:
     <tr>
       <td rowspan='2'>12.17.4</td>
       <td rowspan='2'>18</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chrome, Firefox, Microsoft Edge, Webkit (Experimental)</td>
       <td rowspan='2'>August 31, 2024</td>

diff --git a/docs/web-apps/automated-testing/cypress/advanced.md b/docs/web-apps/automated-testing/cypress/advanced.md
@@ -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];
diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md
@@ -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>

diff --git a/docs/web-apps/automated-testing/playwright.md b/docs/web-apps/automated-testing/playwright.md
@@ -31,14 +31,16 @@ Sauce Labs supports the following test configurations for Playwright:
   <tr>
     <th>Playwright Version</th>
     <th>Node.js Version</th>
-    <th>Supported Platforms</th>
-    <th>Supported Browsers</th>
-    <th>End of Life</th>
+    <th width="10%">Supports Configurable Node.js</th>
+    <th width="20%">Supported Platforms</th>
+    <th width="30%">Supported Browsers</th>
+    <th width="30%">End of Life</th>
   </tr>
   <tbody>
     <tr>
       <td rowspan='2'>1.46.1</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'>✅</td>
       <td><b>macOS:</b> 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>August 28, 2025</td>
@@ -51,6 +53,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.45.2</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>July 23, 2025</td>
@@ -63,6 +66,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.45.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>June 26, 2025</td>
@@ -75,6 +79,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.44.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>May 28, 2025</td>
@@ -87,6 +92,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.43.1</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>April 15, 2025</td>
@@ -99,6 +105,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.41.2</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>February 28, 2025</td>
@@ -111,6 +118,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.41.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>January 22, 2025</td>
@@ -123,6 +131,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.40.1</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>December 6, 2024</td>
@@ -135,6 +144,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.39.0</td>
       <td rowspan='2'>20</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>November 7, 2024</td>
@@ -147,6 +157,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.38.1</td>
       <td rowspan='2'>18</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>September 28, 2024</td>
@@ -159,6 +170,7 @@ Sauce Labs supports the following test configurations for Playwright:
     <tr>
       <td rowspan='2'>1.37.1</td>
       <td rowspan='2'>18</td>
+      <td rowspan='2'></td>
       <td><b>macOS:</b> 11.00, 12, 13</td>
       <td rowspan='2'>Chromium, Chrome, Firefox, Webkit</td>
       <td rowspan='2'>August 31, 2024</td>

diff --git a/docs/web-apps/automated-testing/playwright/advanced.md b/docs/web-apps/automated-testing/playwright/advanced.md
@@ -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];
diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md
@@ -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>