Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: explain node.js usage #961

Merged
merged 2 commits into from
Jul 14, 2023
Merged

docs: explain node.js usage #961

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e07eeb
docs: explain node.js usage
MikeMcC399 Jul 12, 2023
8807fc1
Merge branch 'master' into docs/node-js-usage
MikeMcC399 Jul 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
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