@cypress/github-action 6.6.1 → 6.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +68 -56
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -46,6 +46,7 @@
46
46
  - Use different [working-directory](#working-directory)
47
47
  - Use [subfolders](#subfolders)
48
48
  - Use [pnpm](#pnpm)
49
+ - Use [pnpm workspaces](#pnpm-workspaces)
49
50
  - Use [Yarn Classic](#yarn-classic)
50
51
  - Use [Yarn Modern](#yarn-modern)
51
52
  - Use [Yarn Plug'n'Play](#yarn-plugnplay)
@@ -66,7 +67,7 @@ Examples contained in this repository, based on current Cypress versions, can be
66
67
 
67
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
68
69
 
69
- [![End-to-End example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
70
+ [![End-to-End example](https://github.com/cypress-io/github-action/actions/workflows/example-basic.yml/badge.svg)](.github/workflows/example-basic.yml)
70
71
 
71
72
  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`.
72
73
 
@@ -89,7 +90,7 @@ jobs:
89
90
  uses: cypress-io/github-action@v6
90
91
  ```
91
92
 
92
- [![End-to-End example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
93
+ [![End-to-End example](https://github.com/cypress-io/github-action/actions/workflows/example-basic.yml/badge.svg)](.github/workflows/example-basic.yml)
93
94
 
94
95
  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.
95
96
 
@@ -100,7 +101,7 @@ This workflow uses the default [test type](https://on.cypress.io/guides/overview
100
101
  To use [Cypress Component Testing](https://on.cypress.io/component-testing) add `component: true`
101
102
 
102
103
  ```yml
103
- name: End-to-end tests
104
+ name: Component tests
104
105
  on: push
105
106
  jobs:
106
107
  cypress-run:
@@ -114,7 +115,7 @@ jobs:
114
115
  component: true
115
116
  ```
116
117
 
117
- [![Component Testing example](https://github.com/cypress-io/github-action/workflows/example-component-test/badge.svg?branch=master)](.github/workflows/example-component-test.yml)
118
+ [![Component Testing example](https://github.com/cypress-io/github-action/actions/workflows/example-component-test.yml/badge.svg)](.github/workflows/example-component-test.yml)
118
119
 
119
120
  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.
120
121
 
@@ -160,7 +161,7 @@ jobs:
160
161
  browser: chrome
161
162
  ```
162
163
 
163
- [![Chrome example](https://github.com/cypress-io/github-action/workflows/example-chrome/badge.svg?branch=master)](.github/workflows/example-chrome.yml)
164
+ [![Chrome example](https://github.com/cypress-io/github-action/actions/workflows/example-chrome.yml/badge.svg)](.github/workflows/example-chrome.yml)
164
165
 
165
166
  ### Firefox
166
167
 
@@ -178,7 +179,7 @@ jobs:
178
179
  browser: firefox
179
180
  ```
180
181
 
181
- [![Firefox example](https://github.com/cypress-io/github-action/workflows/example-firefox/badge.svg?branch=master)](.github/workflows/example-firefox.yml)
182
+ [![Firefox example](https://github.com/cypress-io/github-action/actions/workflows/example-firefox.yml/badge.svg)](.github/workflows/example-firefox.yml)
182
183
 
183
184
  ### Edge
184
185
 
@@ -196,7 +197,7 @@ jobs:
196
197
  browser: edge
197
198
  ```
198
199
 
199
- [![Edge example](https://github.com/cypress-io/github-action/workflows/example-edge/badge.svg?branch=master)](.github/workflows/example-edge.yml)
200
+ [![Edge example](https://github.com/cypress-io/github-action/actions/workflows/example-edge.yml/badge.svg)](.github/workflows/example-edge.yml)
200
201
 
201
202
  ### Headed
202
203
 
@@ -244,7 +245,7 @@ Include `options: --user 1001` to avoid permissions issues.
244
245
 
245
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.
246
247
 
247
- [![Docker example](https://github.com/cypress-io/github-action/workflows/example-docker/badge.svg?branch=master)](.github/workflows/example-docker.yml)
248
+ [![Docker example](https://github.com/cypress-io/github-action/actions/workflows/example-docker.yml/badge.svg)](.github/workflows/example-docker.yml)
248
249
 
249
250
  ### Env
250
251
 
@@ -287,7 +288,7 @@ jobs:
287
288
 
288
289
  For more examples, see the workflows below, using environment variables for [recording](#record-test-results-on-cypress-cloud).
289
290
 
290
- [![Env example](https://github.com/cypress-io/github-action/workflows/example-env/badge.svg?branch=master)](.github/workflows/example-env.yml)
291
+ [![Env example](https://github.com/cypress-io/github-action/actions/workflows/example-env.yml/badge.svg)](.github/workflows/example-env.yml)
291
292
 
292
293
  ### Specs
293
294
 
@@ -368,7 +369,7 @@ jobs:
368
369
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
369
370
  ```
370
371
 
371
- [![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml)
372
+ [![recording example](https://github.com/cypress-io/github-action/actions/workflows/example-recording.yml/badge.svg)](.github/workflows/example-recording.yml)
372
373
 
373
374
  ### Project ID and Record Key
374
375
 
@@ -508,7 +509,7 @@ jobs:
508
509
  # let's make sure our "app" works on several versions of Node
509
510
  strategy:
510
511
  matrix:
511
- node: [18, 20, 21]
512
+ node: [18, 20, 22]
512
513
  name: E2E on Node v${{ matrix.node }}
513
514
  steps:
514
515
  - name: Setup Node
@@ -618,7 +619,7 @@ jobs:
618
619
  quiet: true
619
620
  ```
620
621
 
621
- [![example-quiet](https://github.com/cypress-io/github-action/workflows/example-quiet/badge.svg?branch=master)](.github/workflows/example-quiet.yml)
622
+ [![example-quiet](https://github.com/cypress-io/github-action/actions/workflows/example-quiet.yml/badge.svg)](.github/workflows/example-quiet.yml)
622
623
 
623
624
  ### Config
624
625
 
@@ -641,7 +642,7 @@ jobs:
641
642
  config: pageLoadTimeout=100000,baseUrl=http://localhost:3000
642
643
  ```
643
644
 
644
- [![example-config](https://github.com/cypress-io/github-action/workflows/example-config/badge.svg?branch=master)](.github/workflows/example-config.yml)
645
+ [![example-config](https://github.com/cypress-io/github-action/actions/workflows/example-config.yml/badge.svg)](.github/workflows/example-config.yml)
645
646
 
646
647
  ### Config File
647
648
 
@@ -664,7 +665,7 @@ jobs:
664
665
  config-file: cypress.config-alternate.js
665
666
  ```
666
667
 
667
- [![example-config](https://github.com/cypress-io/github-action/workflows/example-config/badge.svg?branch=master)](.github/workflows/example-config.yml)
668
+ [![example-config](https://github.com/cypress-io/github-action/actions/workflows/example-config.yml/badge.svg)](.github/workflows/example-config.yml)
668
669
 
669
670
  ### Parallel
670
671
 
@@ -710,9 +711,13 @@ jobs:
710
711
 
711
712
  ![Parallel run](images/parallel.png)
712
713
 
713
- **Warning ⚠️:** Cypress actions use `GITHUB_TOKEN` to get the correct branch and the number of jobs run, making it possible to re-run without the need of pushing an empty commit. If you don't want to use the `GITHUB_TOKEN` you can still run your tests without problem with the only note that Cypress Cloud's API connects parallel jobs into a single logical run using GitHub commit SHA plus workflow name. If you attempt to re-run GitHub checks, Cypress Cloud thinks the run has already ended. In order to truly rerun parallel jobs, push an empty commit with `git commit --allow-empty -m "re-run checks" && git push`. As another work around you can generate and cache a custom build id, read [Adding a unique build number to GitHub Actions](https://medium.com/attest-engineering/adding-a-unique-github-build-identifier-7aa2e83cadca).
714
+ The Cypress GH Action does not spawn or create any additional containers - it only links the multiple containers spawned using the matrix strategy into a single logical Cypress Cloud run where it splits the specs amongst the machines. See the [Cypress Cloud Smart Orchestration](https://on.cypress.io/guides/cloud/smart-orchestration/) guide for a detailed explanation.
715
+
716
+ If you use the GitHub Actions facility for [Re-running workflows and jobs](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs), note that [Re-running failed jobs in a workflow](https://docs.github.com/en/actions/managing-workflow-runs/re-running-workflows-and-jobs?tool=webui#re-running-failed-jobs-in-a-workflow) is not suited for use with parallel recording into Cypress Cloud. Re-running failed jobs in this situation does not simply re-run failed Cypress tests. Instead it re-runs **all** Cypress tests, load-balanced over the containers with failed jobs.
714
717
 
715
- The Cypress GH Action does not spawn or create any additional containers - it only links the multiple containers spawned using the matrix strategy into a single logical Cypress Cloud run where it splits the specs amongst the machines. See the [Cypress parallelization](https://on.cypress.io/parallelization) guide for the explanation.
718
+ To optimize runs when there are failing tests present, refer to optional [Cypress Cloud Smart Orchestration](https://on.cypress.io/guides/cloud/smart-orchestration/) Premium features:
719
+ - [Spec Prioritization](https://on.cypress.io/guides/cloud/smart-orchestration/spec-prioritization)
720
+ - [Run Cancellation](https://docs.cypress.io/guides/cloud/smart-orchestration/run-cancellation). See also [Specify auto cancel after failures](#specify-auto-cancel-after-failures) for details of how to set this option in a Cypress GH Action workflow.
716
721
 
717
722
  During staged rollout of a new GitHub-hosted runner version, GitHub may provide a mixture of current and new image versions used by the container matrix. It is recommended to use a [Docker image](#docker-image) in the parallel job run which avoids any Cypress Cloud errors due to browser major version mismatch from the two different image versions. A [Docker image](#docker-image) is not necessary if testing against the default built-in Electron browser because this browser version is fixed by the Cypress version in use and it is unaffected by any GitHub runner image rollout.
718
723
 
@@ -793,7 +798,7 @@ jobs:
793
798
  start-windows: npm run start:windows:server
794
799
  ```
795
800
 
796
- [![start example](https://github.com/cypress-io/github-action/workflows/example-start/badge.svg?branch=master)](.github/workflows/example-start.yml)
801
+ [![start example](https://github.com/cypress-io/github-action/actions/workflows/example-start.yml/badge.svg)](.github/workflows/example-start.yml)
797
802
 
798
803
  **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.
799
804
 
@@ -825,7 +830,7 @@ with:
825
830
  npm run web
826
831
  ```
827
832
 
828
- [![start example](https://github.com/cypress-io/github-action/workflows/example-start/badge.svg?branch=master)](.github/workflows/example-start.yml)
833
+ [![start example](https://github.com/cypress-io/github-action/actions/workflows/example-start.yml/badge.svg)](.github/workflows/example-start.yml)
829
834
 
830
835
  ### Wait-on
831
836
 
@@ -848,9 +853,9 @@ jobs:
848
853
  wait-on: 'http://localhost:8080'
849
854
  ```
850
855
 
851
- [![wait-on example](https://github.com/cypress-io/github-action/workflows/example-wait-on/badge.svg?branch=master)](.github/workflows/example-wait-on.yml)
856
+ [![wait-on example](https://github.com/cypress-io/github-action/actions/workflows/example-wait-on.yml/badge.svg)](.github/workflows/example-wait-on.yml)
852
857
 
853
- [![Webpack Dev Server example](https://github.com/cypress-io/github-action/workflows/example-webpack/badge.svg?branch=master)](.github/workflows/example-webpack.yml) (also uses `wait-on`)
858
+ [![Webpack Dev Server example](https://github.com/cypress-io/github-action/actions/workflows/example-webpack.yml/badge.svg)](.github/workflows/example-webpack.yml) (also uses `wait-on`)
854
859
 
855
860
  By default, `wait-on` will retry for 60 seconds. You can pass a custom timeout in seconds using `wait-on-timeout`.
856
861
 
@@ -1099,8 +1104,8 @@ jobs:
1099
1104
 
1100
1105
  ### pnpm
1101
1106
 
1102
- The package manager `pnpm` is not pre-installed in [GitHub Actions runner images](https://github.com/actions/runner-images) (unlike `npm` and `yarn`): to install `pnpm` include [pnpm/action-setup](https://github.com/pnpm/action-setup) in your workflow. If the action finds a `pnpm-lock.yaml` file, it uses the [pnpm](https://pnpm.io/cli/install) command `pnpm install --frozen-lockfile` by default to install dependencies.
1103
- At this time the action does not automatically cache dependencies installed by pnpm. The example below includes steps to locate the pnpm store directory and to cache its contents for later use.
1107
+ The package manager `pnpm` is not pre-installed in [GitHub Actions runner images](https://github.com/actions/runner-images) (unlike `npm` and `yarn`) and so it must be installed in a separate workflow step (see below). If the action finds a `pnpm-lock.yaml` file, it uses the [pnpm](https://pnpm.io/cli/install) command `pnpm install --frozen-lockfile` by default to install dependencies.
1108
+ At this time, the action does not automatically cache dependencies installed by pnpm. We advise against attempting to work around this restriction, by caching the pnpm store directory through additional workflow steps, as this can lead to the action skipping installation of the Cypress binary, causing workflow failure.
1104
1109
 
1105
1110
  ```yaml
1106
1111
  name: example-basic-pnpm
@@ -1112,27 +1117,38 @@ jobs:
1112
1117
  - name: Checkout
1113
1118
  uses: actions/checkout@v4
1114
1119
  - name: Install pnpm
1115
- uses: pnpm/action-setup@v2
1116
- with:
1117
- version: 8
1118
- - name: Get pnpm store directory
1119
- shell: bash
1120
- run: |
1121
- echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
1122
- - name: Setup pnpm cache
1123
- uses: actions/cache@v4
1124
- with:
1125
- path: ${{ env.STORE_PATH }}
1126
- key: ${{ runner.os }}-pnpm-store-${{ hashFiles('examples/basic-pnpm/pnpm-lock.yaml') }}
1127
- restore-keys: |
1128
- ${{ runner.os }}-pnpm-store-
1120
+ run: npm install -g pnpm@9
1129
1121
  - name: Cypress run
1130
1122
  uses: cypress-io/github-action@v6
1131
1123
  with:
1132
1124
  working-directory: examples/basic-pnpm
1133
1125
  ```
1134
1126
 
1135
- [![pnpm example](https://github.com/cypress-io/github-action/workflows/example-basic-pnpm/badge.svg?branch=master)](.github/workflows/example-basic-pnpm.yml)
1127
+ [![pnpm example](https://github.com/cypress-io/github-action/actions/workflows/example-basic-pnpm.yml/badge.svg)](.github/workflows/example-basic-pnpm.yml)
1128
+
1129
+ ### pnpm workspaces
1130
+
1131
+ If you are using [pnpm workspaces](https://pnpm.io/workspaces) you need to install dependencies and run Cypress tests in a workspace in separate steps. The snippet below shows this principle.
1132
+
1133
+ ```yml
1134
+ ...
1135
+ - name: Install dependencies
1136
+ uses: cypress-io/github-action@v6
1137
+ with:
1138
+ working-directory: examples/start-and-pnpm-workspaces
1139
+ runTests: false
1140
+
1141
+ - name: Cypress test
1142
+ uses: cypress-io/github-action@v6
1143
+ with:
1144
+ install: false
1145
+ working-directory: examples/start-and-pnpm-workspaces/packages/workspace-1
1146
+ ...
1147
+ ```
1148
+
1149
+ [![pnpm workspaces example](https://github.com/cypress-io/github-action/actions/workflows/example-start-and-pnpm-workspaces.yml/badge.svg)](.github/workflows/example-start-and-pnpm-workspaces.yml)
1150
+
1151
+ 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.
1136
1152
 
1137
1153
  ### Yarn Classic
1138
1154
 
@@ -1153,7 +1169,7 @@ jobs:
1153
1169
  working-directory: examples/yarn-classic
1154
1170
  ```
1155
1171
 
1156
- [![Yarn classic example](https://github.com/cypress-io/github-action/workflows/example-yarn-classic/badge.svg?branch=master)](.github/workflows/example-yarn-classic.yml)
1172
+ [![Yarn classic example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-classic.yml/badge.svg)](.github/workflows/example-yarn-classic.yml)
1157
1173
 
1158
1174
  ### Yarn Modern
1159
1175
 
@@ -1178,7 +1194,7 @@ jobs:
1178
1194
  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.
1179
1195
  (Note that `github-action` is not compatible with the `nodeLinker: pnpm` setting.)
1180
1196
 
1181
- [![Yarn Modern example](https://github.com/cypress-io/github-action/workflows/example-yarn-modern/badge.svg?branch=master)](.github/workflows/example-yarn-modern.yml)
1197
+ [![Yarn Modern example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern.yml/badge.svg)](.github/workflows/example-yarn-modern.yml)
1182
1198
 
1183
1199
  ### Yarn Plug'n'Play
1184
1200
 
@@ -1203,7 +1219,7 @@ jobs:
1203
1219
 
1204
1220
  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.
1205
1221
 
1206
- [![Yarn Plug'n'Play example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml/badge.svg?branch=master)](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml)
1222
+ [![Yarn Plug'n'Play example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml/badge.svg)](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml)
1207
1223
 
1208
1224
  **Caution**: using the action parameter `command` causes multiple other parameters to be ignored. [See `command` section for more information.](#custom-test-command)
1209
1225
 
@@ -1230,7 +1246,7 @@ jobs:
1230
1246
  wait-on: 'http://localhost:5000'
1231
1247
  ```
1232
1248
 
1233
- [![Yarn workspaces example](https://github.com/cypress-io/github-action/workflows/example-start-and-yarn-workspaces/badge.svg?branch=master)](.github/workflows/example-start-and-yarn-workspaces.yml)
1249
+ [![Yarn workspaces example](https://github.com/cypress-io/github-action/actions/workflows/example-start-and-yarn-workspaces.yml/badge.svg)](.github/workflows/example-start-and-yarn-workspaces.yml)
1234
1250
 
1235
1251
  ### Custom cache key
1236
1252
 
@@ -1245,7 +1261,7 @@ jobs:
1245
1261
  # let's make sure our "app" works on several versions of Node
1246
1262
  strategy:
1247
1263
  matrix:
1248
- node: [18, 20, 21]
1264
+ node: [18, 20, 22]
1249
1265
  name: E2E on Node v${{ matrix.node }}
1250
1266
  steps:
1251
1267
  - name: Setup Node
@@ -1279,7 +1295,7 @@ jobs:
1279
1295
  runs-on: ubuntu-22.04
1280
1296
  strategy:
1281
1297
  matrix:
1282
- node: [18, 20, 21]
1298
+ node: [18, 20, 22]
1283
1299
  name: E2E on Node v${{ matrix.node }}
1284
1300
  steps:
1285
1301
  - uses: actions/setup-node@v4
@@ -1291,7 +1307,7 @@ jobs:
1291
1307
 
1292
1308
  See the [Node.js](#nodejs) section for information about supported versions and usage of Node.js.
1293
1309
 
1294
- [![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)
1310
+ [![Node versions example](https://github.com/cypress-io/github-action/actions/workflows/example-node-versions.yml/badge.svg)](.github/workflows/example-node-versions.yml)
1295
1311
 
1296
1312
  ### Split install and tests
1297
1313
 
@@ -1344,7 +1360,7 @@ If the project has many dependencies, but you want to install just Cypress you c
1344
1360
  install: false
1345
1361
  ```
1346
1362
 
1347
- [![Install only Cypress example](https://github.com/cypress-io/github-action/workflows/example-install-only/badge.svg?branch=master)](.github/workflows/example-install-only.yml)
1363
+ [![Install only Cypress example](https://github.com/cypress-io/github-action/actions/workflows/example-install-only.yml/badge.svg)](.github/workflows/example-install-only.yml)
1348
1364
 
1349
1365
  ### Timeouts
1350
1366
 
@@ -1480,7 +1496,7 @@ This is an example of using the step output `resultsUrl`:
1480
1496
 
1481
1497
  The GitHub step output `dashboardUrl` is deprecated. Cypress Dashboard is now [Cypress Cloud](https://on.cypress.io/cloud-introduction).
1482
1498
 
1483
- [![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml)
1499
+ [![recording example](https://github.com/cypress-io/github-action/actions/workflows/example-recording.yml/badge.svg)](.github/workflows/example-recording.yml)
1484
1500
 
1485
1501
  **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.
1486
1502
 
@@ -1551,7 +1567,7 @@ jobs:
1551
1567
  uses: cypress-io/github-action@v6
1552
1568
  ```
1553
1569
 
1554
- [![cron example](https://github.com/cypress-io/github-action/workflows/example-cron/badge.svg?branch=master)](.github/workflows/example-cron.yml)
1570
+ [![cron example](https://github.com/cypress-io/github-action/actions/workflows/example-cron.yml/badge.svg)](.github/workflows/example-cron.yml)
1555
1571
 
1556
1572
  ### Job summary title
1557
1573
 
@@ -1608,8 +1624,7 @@ jobs:
1608
1624
 
1609
1625
  Node.js is required to run this action. The recommended version `v6` supports:
1610
1626
 
1611
- - **Node.js** 18.x
1612
- - **Node.js** 20.x and above
1627
+ - **Node.js** 18.x, 20.x and 22.x
1613
1628
 
1614
1629
  and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).
1615
1630
 
@@ -1617,7 +1632,7 @@ and is generally aligned with [Node.js's release schedule](https://github.com/no
1617
1632
 
1618
1633
  `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.
1619
1634
 
1620
- [![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)
1635
+ [![Node versions example](https://github.com/cypress-io/github-action/actions/workflows/example-node-versions.yml/badge.svg)](.github/workflows/example-node-versions.yml)
1621
1636
 
1622
1637
  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`.
1623
1638
 
@@ -1627,11 +1642,8 @@ View the [CHANGELOG](./CHANGELOG.md) document for an overview of version changes
1627
1642
 
1628
1643
  ## Compatibility
1629
1644
 
1630
- - `v6` is the current recommended version and uses `node20`
1631
- - `v5` uses the deprecated version `node16`
1632
- - `v4` is the minimum version required for Cypress `10.x` and later - also uses the deprecated version `node16`
1633
-
1634
- Pay attention to any GitHub Actions deprecation warnings shown in logs which may recommend updating.
1645
+ - `github-action@v6` is the current recommended version and uses `node20`
1646
+ - `github-action` versions `v1` to `v5` are unsupported: they rely on Node.js `12` and `16` in End-of-life status.
1635
1647
 
1636
1648
  ## Contributing
1637
1649
 
@@ -1644,7 +1656,7 @@ Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to
1644
1656
  This project is licensed under the terms of the [MIT license][license-file].
1645
1657
 
1646
1658
  <!-- badge links follow -->
1647
- [ci-badge]: https://github.com/cypress-io/github-action/workflows/main/badge.svg?branch=master
1659
+ [ci-badge]: https://github.com/cypress-io/github-action/actions/workflows/main.yml/badge.svg
1648
1660
  [ci-workflow]: https://github.com/cypress-io/github-action/actions/workflows/main.yml
1649
1661
  [cloud-badge]: https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/3tb7jn/master&style=flat&logo=cypress
1650
1662
  [cloud-project]: https://cloud.cypress.io/projects/3tb7jn/runs
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cypress/github-action",
3
- "version": "6.6.1",
3
+ "version": "6.7.0",
4
4
  "description": "GitHub Action for running Cypress end-to-end and component tests",
5
5
  "private": false,
6
6
  "main": "dist/index.js",
@@ -15,7 +15,7 @@
15
15
  "format": "prettier --write index.js src/ping.js",
16
16
  "check:markdown": "find *.md docs/*.md -print0 | xargs -0 -n1 markdown-link-check -c md-linkcheck.json",
17
17
  "update:cypress": "./scripts/update-cypress-latest.sh",
18
- "prepare": "husky install"
18
+ "prepare": "husky"
19
19
  },
20
20
  "repository": {
21
21
  "type": "git",
@@ -46,11 +46,11 @@
46
46
  "supports-color": "9.3.1"
47
47
  },
48
48
  "devDependencies": {
49
- "@types/node": "20.10.8",
49
+ "@types/node": "20.12.12",
50
50
  "@vercel/ncc": "0.38.1",
51
- "husky": "8.0.3",
52
- "markdown-link-check": "3.11.1",
53
- "prettier": "3.2.4"
51
+ "husky": "9.0.11",
52
+ "markdown-link-check": "3.12.2",
53
+ "prettier": "3.2.5"
54
54
  },
55
55
  "publishConfig": {
56
56
  "access": "public"