Skip to content

Commit

Permalink
docs: explain node.js usage
Browse files Browse the repository at this point in the history
  • Loading branch information
MikeMcC399 committed Jul 12, 2023
1 parent 3881773 commit 5e07eeb
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1185,6 +1185,8 @@ jobs:
- uses: cypress-io/github-action@v5
```

See the [Node.js](#nodejs) section for information about supported versions and usage of Node.js.

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

### Split install and tests
Expand Down Expand Up @@ -1475,7 +1477,9 @@ jobs:
publish-summary: false
```

## Node.js Support
## Node.js

### Support

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

Expand All @@ -1485,6 +1489,14 @@ Node.js is required to run this action. The current version `v5` supports:

and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).

### Usage

`github-action` command-type options such as [`install-command`](https://github.com/cypress-io/github-action#custom-install-command), [`build`](https://github.com/cypress-io/github-action#build-app), [`start`](https://github.com/cypress-io/github-action#start-server) and [`command`](https://github.com/cypress-io/github-action#custom-test-command) are executed with the runner's version of Node.js. You can use GitHub's [actions/setup-node](https://github.com/actions/setup-node) to install an explicit Node.js version into the runner.

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

Cypress itself runs with a fixed Node.js version specified by the [runs.using](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-javascript-actions) parameter of [action.yml](action.yml). For `github-action@v5` this is `node16`.

## Changelog

See [Releases](https://github.com/cypress-io/github-action/releases) for full details of changes.
Expand Down

0 comments on commit 5e07eeb

Please sign in to comment.