Skip to content

Commit

Permalink
docs: add node.js support information (cypress-io#847)
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 committed Mar 23, 2023
1 parent 2c13ad4 commit e2fd3ea
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ jobs:
# let's make sure our "app" works on several versions of Node
strategy:
matrix:
node: [14, 16, 18]
node: [14, 16, 18, 19]
name: E2E on Node v${{ matrix.node }}
steps:
- name: Setup Node
Expand All @@ -435,7 +435,7 @@ The recording will have tags as labels on the run.
![Tags](images/tags.png)
You can pass multiple tags using commas like `tag: node-10,nightly,staging`.
You can pass multiple tags using commas like `tag: node-18,nightly,staging`.

### Specify auto cancel after failures

Expand Down Expand Up @@ -1107,7 +1107,7 @@ jobs:
# let's make sure our "app" works on several versions of Node
strategy:
matrix:
node: [14, 16, 18]
node: [14, 16, 18, 19]
name: E2E on Node v${{ matrix.node }}
steps:
- name: Setup Node
Expand Down Expand Up @@ -1141,7 +1141,7 @@ jobs:
runs-on: ubuntu-22.04
strategy:
matrix:
node: [14, 16, 18]
node: [14, 16, 18, 19]
name: E2E on Node v${{ matrix.node }}
steps:
- uses: actions/setup-node@v3
Expand All @@ -1153,8 +1153,6 @@ jobs:

[![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)

**Note:** because this action uses `npm ci` and `npx` commands, it requires at least Node 8.12 that includes the version of NPM with those commands.

### Split install and tests

Sometimes you may want to run additional commands between installation and tests. To enable this use the `install` and `runTests` parameters.
Expand Down Expand Up @@ -1259,9 +1257,15 @@ This action installs local dependencies using lock files. Ensure that exactly on

See section [Yarn Modern](#yarn-modern) for information about using Yarn version 2 and later.

#### Minimum Node.js
#### Node.js Support

Node.js is required to run this action. The current version `v5` supports:

- **Node.js** 14.x
- **Node.js** 16.x
- **Node.js** 18.x and above

This action uses several production dependencies. The minimum Node version required to run this action depends on the minimum Node version required by the dependencies.
and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).

## Debugging

Expand Down

0 comments on commit e2fd3ea

Please sign in to comment.