Skip to content

Commit

Permalink
Remove nodeVersion documentation (#5318)
Browse files Browse the repository at this point in the history
* Remove reference to 'nodeVersion'

* added history, removed changes to legacy
  • Loading branch information
mjhenkes committed Jul 19, 2023
1 parent dcea3ed commit a0fcdf8
Showing 1 changed file with 2 additions and 23 deletions.
25 changes: 2 additions & 23 deletions docs/guides/references/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,28 +162,6 @@ For more options regarding screenshots, view the
For more information, see the docs on
[actionability](/guides/core-concepts/interacting-with-elements#Actionability).

### Node version

:::caution

<Icon name="exclamation-triangle" /> The <code>nodeVersion</code> configuration option is deprecated and will be removed in a
future version of Cypress. Please remove this option from your configuration
file.

:::

| Option | Default | Description |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeVersion` | `system` | Can be `system` or `bundled`. If set to `system`, Cypress will try to use the same Node version that launched Cypress to execute your [plugins](/guides/tooling/plugins-guide). If that can't be determined, Cypress will use the Node version bundled with Cypress. If set to `bundled` Cypress will use the version bundled with Cypress. |

The Node version is used in Cypress to:

- Build files in the
[supportFile](#Folders-Files).
- Execute code in the config file.

<DocsImage src="/img/guides/configuration/test-runner-settings-nodejs-version.jpg" alt="Node version in Settings in Cypress" />

### Experiments

Configuration might include experimental options currently being tested. See
Expand Down Expand Up @@ -235,7 +213,7 @@ object:
| `supportFile` | `cypress/support/component.js` | Path to file to load before spec files load. This file is compiled and bundled. (Pass `false` to disable) |
| `specPattern` | <code>\*\*/*.cy.{js,jsx,ts,tsx}</code> | A glob pattern String or Array of glob pattern Strings of the spec files to load. <br /><br />Note that any files found matching the `e2e.specPattern` value will be automatically **excluded.** |
| `excludeSpecPattern` | `['/snapshots/*', '/image_snapshots/*']` | A String or Array of glob patterns used to ignore spec files that would otherwise be shown in your list of specs. [Please read the notes on using this.](#excludeSpecPattern) |
`experimentalSingleTabRunMode` | `false` | Run all specs in a single tab, instead of creating a new tab per spec. This can improve run mode performance, but can impact spec isolation and reliability on large test suites. This experiment currently only applies to Component Testing.
`experimentalSingleTabRunMode` | `false` | Run all specs in a single tab, instead of creating a new tab per spec. This can improve run mode performance, but can impact spec isolation and reliability on large test suites. This experiment currently only applies to Component Testing.
| `slowTestThreshold` | `250` | Time, in milliseconds, to consider a test "slow" during `cypress run`. A slow test will display in orange text in the default reporter. |


Expand Down Expand Up @@ -740,6 +718,7 @@ DEBUG=cypress:cli,cypress:server:specs

| Version | Changes |
| --------------------------------------------- | ------------------------------------------------------------------------------------- |
| [13.0.0](/guides/references/changelog#13-0-0) | Removed `nodeVersion` option. |
| [13.0.0](/guides/references/changelog#13-0-0) | Removed `videoUploadOnPasses` option. |
| [11.0.0](/guides/references/changelog#11-0-0) | Removed `e2e.experimentalSessionAndOrigin` option. |
| [10.4.0](/guides/references/changelog#10-4-0) | Added `e2e.testIsolation` option. |
Expand Down

0 comments on commit a0fcdf8

Please sign in to comment.