You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+28-28
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ Examples contained in this repository, based on current Cypress versions, can be
67
67
68
68
Live examples, such as [example-basic.yml](.github/workflows/example-basic.yml) are shown together with a status badge. Click on the status badge to read the source code of the workflow, for example
Older **external** examples based on a [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration) for Cypress `9` and earlier can be found in the [README](https://github.com/cypress-io/github-action/blob/v5/README.md) for version `v5`.
The workflow file [example-basic.yml](.github/workflows/example-basic.yml) shows how Cypress runs on GH Actions using Ubuntu (20 and 22), Windows, and macOS without additional OS dependencies necessary.
See the example project [component-tests](examples/component-tests/) and the [example-component-test.yml](.github/workflows/example-component-test.yml) workflow for more details.
@@ -245,7 +245,7 @@ Include `options: --user 1001` to avoid permissions issues.
245
245
246
246
Refer to [cypress-io/cypress-docker-images](https://github.com/cypress-io/cypress-docker-images) for further information about using Cypress Docker images. Cypress offers the [Cypress Docker Factory](https://github.com/cypress-io/cypress-docker-images/tree/master/factory) to generate additional Docker images with selected components and versions.
**Note:** A server continues to run until the end of the GitHub workflow job that started it. At the end of the job the GitHub workflow runner executes a "Complete job" phase automatically where it terminates any server processes which are still running.
[](.github/workflows/example-webpack.yml) (also uses `wait-on`)
858
+
[](.github/workflows/example-webpack.yml) (also uses `wait-on`)
859
859
860
860
By default, `wait-on` will retry for 60 seconds. You can pass a custom timeout in seconds using `wait-on-timeout`.
See the example project [start-and-pnpm-workspaces](examples/start-and-pnpm-workspaces/) and the [example-start-and-pnpm-workspaces.yml](.github/workflows/example-start-and-pnpm-workspaces.yml) workflow for a full working example including pnpm caching.
This example covers the [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) configuration `nodeLinker: node-modules` which Yarn uses by default for projects updated from Yarn Classic. For `nodeLinker: pnp` see [Yarn Plug'n'Play](#yarn-plugnplay) below.
1206
1206
(Note that `github-action` is not compatible with the `nodeLinker: pnpm` setting.)
1207
1207
1208
-
[](.github/workflows/example-yarn-modern.yml)
1208
+
[](.github/workflows/example-yarn-modern.yml)
1209
1209
1210
1210
### Yarn Plug'n'Play
1211
1211
@@ -1230,7 +1230,7 @@ jobs:
1230
1230
1231
1231
This example covers the [`.yarnrc.yml`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) configuration when `nodeLinker` is undefined or set to `nodeLinker: pnp` corresponding to Yarn Plug'n'Play. Yarn uses this by default for projects newly created with Yarn Modern.
**Caution**: using the action parameter `command` causes multiple other parameters to be ignored. [See `command` section for more information.](#custom-test-command)
@@ -1371,7 +1371,7 @@ If the project has many dependencies, but you want to install just Cypress you c
1371
1371
install: false
1372
1372
```
1373
1373
1374
-
[](.github/workflows/example-install-only.yml)
1374
+
[](.github/workflows/example-install-only.yml)
1375
1375
1376
1376
### Timeouts
1377
1377
@@ -1507,7 +1507,7 @@ This is an example of using the step output `resultsUrl`:
1507
1507
1508
1508
The GitHub step output `dashboardUrl` is deprecated. Cypress Dashboard is now [Cypress Cloud](https://on.cypress.io/cloud-introduction).
**Note:** every GitHub workflow step can have `outcome` and `conclusion` properties. See the GitHub [Contexts](https://docs.github.com/en/actions/learn-github-actions/contexts) documentation section [steps context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context). In particular, the `outcome` or `conclusion` value can be `success`, `failure`, `cancelled`, or `skipped` which you can use in any following steps.
@@ -1644,7 +1644,7 @@ and is generally aligned with [Node.js's release schedule](https://github.com/no
1644
1644
1645
1645
`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.
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). `github-action@v6` uses `node20`.
1650
1650
@@ -1671,7 +1671,7 @@ Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to
1671
1671
This project is licensed under the terms of the [MIT license][license-file].
0 commit comments