@cypress/github-action 6.10.4 → 6.10.6

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 +57 -59
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -99,7 +99,7 @@ jobs:
99
99
  runs-on: ubuntu-24.04
100
100
  steps:
101
101
  - name: Checkout
102
- uses: actions/checkout@v5
102
+ uses: actions/checkout@v6
103
103
  # Install npm dependencies, cache them correctly
104
104
  # and run all Cypress tests
105
105
  - name: Cypress run
@@ -124,7 +124,7 @@ jobs:
124
124
  runs-on: ubuntu-24.04
125
125
  steps:
126
126
  - name: Checkout
127
- uses: actions/checkout@v5
127
+ uses: actions/checkout@v6
128
128
  - name: Cypress run
129
129
  uses: cypress-io/github-action@v6
130
130
  with:
@@ -177,7 +177,7 @@ jobs:
177
177
  runs-on: ubuntu-24.04
178
178
  name: E2E on Chrome
179
179
  steps:
180
- - uses: actions/checkout@v5
180
+ - uses: actions/checkout@v6
181
181
  - uses: cypress-io/github-action@v6
182
182
  with:
183
183
  browser: chrome
@@ -197,7 +197,7 @@ jobs:
197
197
  runs-on: ubuntu-24.04
198
198
  name: E2E on Chrome for Testing
199
199
  steps:
200
- - uses: actions/checkout@v5
200
+ - uses: actions/checkout@v6
201
201
  - uses: browser-actions/setup-chrome@v2
202
202
  with:
203
203
  chrome-version: 140
@@ -218,7 +218,7 @@ jobs:
218
218
  runs-on: ubuntu-24.04
219
219
  name: E2E on Firefox
220
220
  steps:
221
- - uses: actions/checkout@v5
221
+ - uses: actions/checkout@v6
222
222
  - uses: cypress-io/github-action@v6
223
223
  with:
224
224
  browser: firefox
@@ -236,7 +236,7 @@ jobs:
236
236
  runs-on: ubuntu-24.04
237
237
  name: E2E on Edge
238
238
  steps:
239
- - uses: actions/checkout@v5
239
+ - uses: actions/checkout@v6
240
240
  - uses: cypress-io/github-action@v6
241
241
  with:
242
242
  browser: edge
@@ -255,7 +255,7 @@ jobs:
255
255
  cypress-run:
256
256
  runs-on: ubuntu-24.04
257
257
  steps:
258
- - uses: actions/checkout@v5
258
+ - uses: actions/checkout@v6
259
259
  - uses: cypress-io/github-action@v6
260
260
  with:
261
261
  browser: chrome
@@ -278,7 +278,7 @@ jobs:
278
278
  image: cypress/browsers:latest
279
279
  options: --user 1001
280
280
  steps:
281
- - uses: actions/checkout@v5
281
+ - uses: actions/checkout@v6
282
282
  - uses: cypress-io/github-action@v6
283
283
  with:
284
284
  browser: chrome
@@ -302,7 +302,7 @@ jobs:
302
302
  image: cypress/included:latest
303
303
  options: --user 1001
304
304
  steps:
305
- - uses: actions/checkout@v5
305
+ - uses: actions/checkout@v6
306
306
  - uses: cypress-io/github-action@v6
307
307
  with:
308
308
  browser: chrome
@@ -326,7 +326,7 @@ jobs:
326
326
  runs-on: ubuntu-24.04
327
327
  steps:
328
328
  - name: Checkout
329
- uses: actions/checkout@v5
329
+ uses: actions/checkout@v6
330
330
 
331
331
  - name: Cypress run with env
332
332
  uses: cypress-io/github-action@v6
@@ -344,7 +344,7 @@ jobs:
344
344
  runs-on: ubuntu-24.04
345
345
  steps:
346
346
  - name: Checkout
347
- uses: actions/checkout@v5
347
+ uses: actions/checkout@v6
348
348
 
349
349
  - name: Cypress run with env
350
350
  uses: cypress-io/github-action@v6
@@ -370,7 +370,7 @@ jobs:
370
370
  runs-on: ubuntu-24.04
371
371
  steps:
372
372
  - name: Checkout
373
- uses: actions/checkout@v5
373
+ uses: actions/checkout@v6
374
374
 
375
375
  - name: Cypress run
376
376
  uses: cypress-io/github-action@v6
@@ -401,7 +401,7 @@ jobs:
401
401
  runs-on: ubuntu-24.04
402
402
  steps:
403
403
  - name: Checkout
404
- uses: actions/checkout@v5
404
+ uses: actions/checkout@v6
405
405
  - name: Cypress run
406
406
  uses: cypress-io/github-action@v6
407
407
  with:
@@ -433,7 +433,7 @@ jobs:
433
433
  runs-on: ubuntu-24.04
434
434
  steps:
435
435
  - name: Checkout
436
- uses: actions/checkout@v5
436
+ uses: actions/checkout@v6
437
437
 
438
438
  - name: Cypress run
439
439
  uses: cypress-io/github-action@v6
@@ -463,7 +463,7 @@ jobs:
463
463
  runs-on: ubuntu-24.04
464
464
  steps:
465
465
  - name: Checkout
466
- uses: actions/checkout@v5
466
+ uses: actions/checkout@v6
467
467
  - name: Cypress run
468
468
  uses: cypress-io/github-action@v6
469
469
  with:
@@ -496,7 +496,7 @@ jobs:
496
496
  runs-on: ubuntu-24.04
497
497
  steps:
498
498
  - name: Checkout
499
- uses: actions/checkout@v5
499
+ uses: actions/checkout@v6
500
500
  - name: Cypress run
501
501
  uses: cypress-io/github-action@v6
502
502
  with:
@@ -534,7 +534,7 @@ jobs:
534
534
  runs-on: ubuntu-24.04
535
535
  steps:
536
536
  - name: Checkout
537
- uses: actions/checkout@v5
537
+ uses: actions/checkout@v6
538
538
 
539
539
  - name: Cypress run
540
540
  uses: cypress-io/github-action@v6
@@ -573,7 +573,7 @@ jobs:
573
573
  - run: node -v
574
574
 
575
575
  - name: Checkout
576
- uses: actions/checkout@v5
576
+ uses: actions/checkout@v6
577
577
 
578
578
  - name: Cypress run
579
579
  uses: cypress-io/github-action@v6
@@ -606,7 +606,7 @@ jobs:
606
606
  name: E2E
607
607
  steps:
608
608
  - name: Checkout
609
- uses: actions/checkout@v5
609
+ uses: actions/checkout@v6
610
610
 
611
611
  - name: Cypress run
612
612
  uses: cypress-io/github-action@v6
@@ -633,7 +633,7 @@ jobs:
633
633
  runs-on: ubuntu-24.04
634
634
  name: Artifacts
635
635
  steps:
636
- - uses: actions/checkout@v5
636
+ - uses: actions/checkout@v6
637
637
  - uses: cypress-io/github-action@v6
638
638
  # after the test run completes store videos and any screenshots
639
639
  - uses: actions/upload-artifact@v4
@@ -662,7 +662,7 @@ jobs:
662
662
  runs-on: ubuntu-24.04
663
663
  steps:
664
664
  - name: Checkout
665
- uses: actions/checkout@v5
665
+ uses: actions/checkout@v6
666
666
  # Install npm dependencies, cache them correctly
667
667
  # and run all Cypress tests with `quiet` parameter
668
668
  - name: Cypress run
@@ -687,7 +687,7 @@ jobs:
687
687
  runs-on: ubuntu-24.04
688
688
  steps:
689
689
  - name: Checkout
690
- uses: actions/checkout@v5
690
+ uses: actions/checkout@v6
691
691
 
692
692
  - name: Cypress run
693
693
  uses: cypress-io/github-action@v6
@@ -710,7 +710,7 @@ jobs:
710
710
  runs-on: ubuntu-24.04
711
711
  steps:
712
712
  - name: Checkout
713
- uses: actions/checkout@v5
713
+ uses: actions/checkout@v6
714
714
 
715
715
  - name: Cypress run
716
716
  uses: cypress-io/github-action@v6
@@ -744,7 +744,7 @@ jobs:
744
744
  containers: [1, 2, 3]
745
745
  steps:
746
746
  - name: Checkout
747
- uses: actions/checkout@v5
747
+ uses: actions/checkout@v6
748
748
 
749
749
  # because of "record" and "parallel" parameters
750
750
  # these containers will load balance all found tests among themselves
@@ -805,7 +805,7 @@ jobs:
805
805
  runs-on: ubuntu-24.04
806
806
  steps:
807
807
  - name: Checkout
808
- uses: actions/checkout@v5
808
+ uses: actions/checkout@v6
809
809
  - name: Cypress run
810
810
  uses: cypress-io/github-action@v6
811
811
  with:
@@ -824,7 +824,7 @@ jobs:
824
824
  runs-on: ubuntu-24.04
825
825
  steps:
826
826
  - name: Checkout
827
- uses: actions/checkout@v5
827
+ uses: actions/checkout@v6
828
828
  - name: Cypress run
829
829
  uses: cypress-io/github-action@v6
830
830
  with:
@@ -843,7 +843,7 @@ jobs:
843
843
  runs-on: ubuntu-24.04
844
844
  steps:
845
845
  - name: Checkout
846
- uses: actions/checkout@v5
846
+ uses: actions/checkout@v6
847
847
  - name: Cypress run
848
848
  uses: cypress-io/github-action@v6
849
849
  with:
@@ -869,7 +869,7 @@ jobs:
869
869
  runs-on: ubuntu-24.04
870
870
  steps:
871
871
  - name: Checkout
872
- uses: actions/checkout@v5
872
+ uses: actions/checkout@v6
873
873
  - name: Cypress run
874
874
  uses: cypress-io/github-action@v6
875
875
  with:
@@ -899,7 +899,7 @@ jobs:
899
899
  runs-on: ubuntu-24.04
900
900
  steps:
901
901
  - name: Checkout
902
- uses: actions/checkout@v5
902
+ uses: actions/checkout@v6
903
903
  - name: Cypress run
904
904
  uses: cypress-io/github-action@v6
905
905
  with:
@@ -988,7 +988,7 @@ jobs:
988
988
  runs-on: ubuntu-24.04
989
989
  steps:
990
990
  - name: Checkout
991
- uses: actions/checkout@v5
991
+ uses: actions/checkout@v6
992
992
  - name: Cypress run
993
993
  uses: cypress-io/github-action@v6
994
994
  with:
@@ -1015,7 +1015,7 @@ Correct example snippet:
1015
1015
 
1016
1016
  ```yml
1017
1017
  steps:
1018
- - uses: actions/checkout@v5
1018
+ - uses: actions/checkout@v6
1019
1019
  - uses: cypress-io/github-action@v6
1020
1020
  with:
1021
1021
  command: npm run custom-test
@@ -1038,7 +1038,7 @@ jobs:
1038
1038
  # run 3 copies of the current job in parallel
1039
1039
  containers: [1, 2, 3]
1040
1040
  steps:
1041
- - uses: actions/checkout@v5
1041
+ - uses: actions/checkout@v6
1042
1042
  - uses: cypress-io/github-action@v6
1043
1043
  with:
1044
1044
  record: true
@@ -1073,7 +1073,7 @@ jobs:
1073
1073
  smoke-tests:
1074
1074
  needs: ['prepare']
1075
1075
  steps:
1076
- - uses: actions/checkout@v5
1076
+ - uses: actions/checkout@v6
1077
1077
  - uses: cypress-io/github-action@v6
1078
1078
  with:
1079
1079
  record: true
@@ -1113,7 +1113,7 @@ jobs:
1113
1113
  cypress-run:
1114
1114
  runs-on: ubuntu-24.04
1115
1115
  steps:
1116
- - uses: actions/checkout@v5
1116
+ - uses: actions/checkout@v6
1117
1117
  - uses: cypress-io/github-action@v6
1118
1118
  with:
1119
1119
  start: npm start
@@ -1151,7 +1151,7 @@ jobs:
1151
1151
  test:
1152
1152
  runs-on: ubuntu-24.04
1153
1153
  steps:
1154
- - uses: actions/checkout@v5
1154
+ - uses: actions/checkout@v6
1155
1155
  - name: Install root dependencies
1156
1156
  run: npm ci
1157
1157
 
@@ -1179,7 +1179,7 @@ jobs:
1179
1179
  runs-on: ubuntu-24.04
1180
1180
  steps:
1181
1181
  - name: Checkout
1182
- uses: actions/checkout@v5
1182
+ uses: actions/checkout@v6
1183
1183
  - name: Install pnpm
1184
1184
  uses: pnpm/action-setup@v4
1185
1185
  with:
@@ -1200,22 +1200,20 @@ jobs:
1200
1200
 
1201
1201
  ### pnpm workspaces
1202
1202
 
1203
- 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.
1203
+ The action does not directly support using [pnpm workspaces](https://pnpm.io/workspaces) (see feature request [#1144](https://github.com/cypress-io/github-action/issues/1144)). As a workaround, you can install dependencies and run Cypress tests in a workspace in separate steps. The snippet below shows this principle.
1204
1204
 
1205
1205
  ```yml
1206
1206
  ...
1207
1207
  - name: Install dependencies
1208
- uses: cypress-io/github-action@v6
1209
- with:
1210
- working-directory: examples/start-and-pnpm-workspaces
1211
- runTests: false
1208
+ run: pnpm install --frozen-lockfile
1209
+ working-directory: examples/start-and-pnpm-workspaces
1212
1210
 
1213
1211
  - name: Cypress test
1214
1212
  uses: cypress-io/github-action@v6
1215
1213
  with:
1216
1214
  install: false
1217
1215
  working-directory: examples/start-and-pnpm-workspaces/packages/workspace-1
1218
- ...
1216
+ ...
1219
1217
  ```
1220
1218
 
1221
1219
  [![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)
@@ -1234,7 +1232,7 @@ jobs:
1234
1232
  runs-on: ubuntu-24.04
1235
1233
  steps:
1236
1234
  - name: Checkout
1237
- uses: actions/checkout@v5
1235
+ uses: actions/checkout@v6
1238
1236
  - name: Cypress run
1239
1237
  uses: cypress-io/github-action@v6
1240
1238
  with:
@@ -1257,7 +1255,7 @@ jobs:
1257
1255
  runs-on: ubuntu-24.04
1258
1256
  steps:
1259
1257
  - name: Checkout
1260
- uses: actions/checkout@v5
1258
+ uses: actions/checkout@v6
1261
1259
  - run: corepack enable # (experimental and optional)
1262
1260
  - name: Set up Yarn cache
1263
1261
  uses: actions/setup-node@v4
@@ -1291,7 +1289,7 @@ jobs:
1291
1289
  runs-on: ubuntu-24.04
1292
1290
  steps:
1293
1291
  - name: Checkout
1294
- uses: actions/checkout@v5
1292
+ uses: actions/checkout@v6
1295
1293
  - name: Cypress run
1296
1294
  uses: cypress-io/github-action@v6
1297
1295
  with:
@@ -1320,7 +1318,7 @@ jobs:
1320
1318
  # and tests in a subfolder like "workspace-1"
1321
1319
  runs-on: ubuntu-24.04
1322
1320
  steps:
1323
- - uses: actions/checkout@v5
1321
+ - uses: actions/checkout@v6
1324
1322
  - uses: cypress-io/github-action@v6
1325
1323
  with:
1326
1324
  working-directory: examples/start-and-yarn-workspaces/workspace-1
@@ -1352,7 +1350,7 @@ jobs:
1352
1350
  with:
1353
1351
  node-version: ${{ matrix.node }}
1354
1352
  - name: Checkout
1355
- uses: actions/checkout@v5
1353
+ uses: actions/checkout@v6
1356
1354
  # run Cypress tests and record them under the same run
1357
1355
  # associated with commit SHA and just give a different group name
1358
1356
  - name: Cypress run
@@ -1384,7 +1382,7 @@ jobs:
1384
1382
  - uses: actions/setup-node@v4
1385
1383
  with:
1386
1384
  node-version: ${{ matrix.node }}
1387
- - uses: actions/checkout@v5
1385
+ - uses: actions/checkout@v6
1388
1386
  - uses: cypress-io/github-action@v6
1389
1387
  ```
1390
1388
 
@@ -1403,7 +1401,7 @@ jobs:
1403
1401
  test:
1404
1402
  runs-on: ubuntu-24.04
1405
1403
  steps:
1406
- - uses: actions/checkout@v5
1404
+ - uses: actions/checkout@v6
1407
1405
  - name: Install dependencies
1408
1406
  uses: cypress-io/github-action@v6
1409
1407
  with:
@@ -1436,7 +1434,7 @@ jobs:
1436
1434
  build:
1437
1435
  runs-on: ubuntu-24.04
1438
1436
  steps:
1439
- - uses: actions/checkout@v5
1437
+ - uses: actions/checkout@v6
1440
1438
  - name: Build app
1441
1439
  uses: cypress-io/github-action@v6
1442
1440
  with:
@@ -1454,7 +1452,7 @@ jobs:
1454
1452
  needs: build
1455
1453
  runs-on: ubuntu-24.04
1456
1454
  steps:
1457
- - uses: actions/checkout@v5
1455
+ - uses: actions/checkout@v6
1458
1456
  - name: Restore build artifacts
1459
1457
  uses: actions/download-artifact@v4
1460
1458
  with:
@@ -1478,7 +1476,7 @@ Finally, you might not need this GH Action at all. For example, if you want to s
1478
1476
  If the project has many dependencies, but you want to install just Cypress you can combine this action with `actions/cache` and `npm i cypress` commands yourself.
1479
1477
 
1480
1478
  ```yml
1481
- - uses: actions/checkout@v5
1479
+ - uses: actions/checkout@v6
1482
1480
  - uses: actions/cache@v4
1483
1481
  with:
1484
1482
  path: |
@@ -1505,7 +1503,7 @@ jobs:
1505
1503
  # to prevent a hanging process from using all your CI minutes
1506
1504
  timeout-minutes: 10
1507
1505
  steps:
1508
- - uses: actions/checkout@v5
1506
+ - uses: actions/checkout@v6
1509
1507
  - uses: cypress-io/github-action@v6
1510
1508
  # you can specify individual step timeout too
1511
1509
  timeout-minutes: 5
@@ -1548,7 +1546,7 @@ jobs:
1548
1546
  runs-on: ubuntu-24.04
1549
1547
  steps:
1550
1548
  - name: Check out repo
1551
- uses: actions/checkout@v5
1549
+ uses: actions/checkout@v6
1552
1550
  - name: Cypress run # install dependencies and run Cypress E2E tests
1553
1551
  uses: cypress-io/github-action@v6 # replaces CLI cypress run
1554
1552
  with:
@@ -1735,7 +1733,7 @@ jobs:
1735
1733
  runs-on: ubuntu-24.04
1736
1734
  steps:
1737
1735
  - name: Checkout
1738
- uses: actions/checkout@v5
1736
+ uses: actions/checkout@v6
1739
1737
  - name: Cypress run
1740
1738
  uses: cypress-io/github-action@v6
1741
1739
  with:
@@ -1752,7 +1750,7 @@ jobs:
1752
1750
  runs-on: ubuntu-24.04
1753
1751
  steps:
1754
1752
  - name: Checkout
1755
- uses: actions/checkout@v5
1753
+ uses: actions/checkout@v6
1756
1754
  - name: Cypress install
1757
1755
  uses: cypress-io/github-action@v6
1758
1756
  with:
@@ -1783,7 +1781,7 @@ jobs:
1783
1781
  runs-on: ubuntu-24.04
1784
1782
  steps:
1785
1783
  - name: Checkout
1786
- uses: actions/checkout@v5
1784
+ uses: actions/checkout@v6
1787
1785
  - name: Cypress nightly tests 🌃
1788
1786
  uses: cypress-io/github-action@v6
1789
1787
  ```
@@ -1803,7 +1801,7 @@ jobs:
1803
1801
  tests:
1804
1802
  runs-on: ubuntu-24.04
1805
1803
  steps:
1806
- - uses: actions/checkout@v5
1804
+ - uses: actions/checkout@v6
1807
1805
  - name: Cypress headless tests
1808
1806
  uses: cypress-io/github-action@v6
1809
1807
  with:
@@ -1832,7 +1830,7 @@ jobs:
1832
1830
  runs-on: ubuntu-24.04
1833
1831
  steps:
1834
1832
  - name: Checkout
1835
- uses: actions/checkout@v5
1833
+ uses: actions/checkout@v6
1836
1834
  - name: Cypress run
1837
1835
  uses: cypress-io/github-action@v6
1838
1836
  with:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cypress/github-action",
3
- "version": "6.10.4",
3
+ "version": "6.10.6",
4
4
  "description": "GitHub Action for running Cypress end-to-end and component tests",
5
5
  "private": false,
6
6
  "main": "dist/index.js",
@@ -61,7 +61,7 @@
61
61
  "eslint-plugin-cypress": "5.2.0",
62
62
  "globals": "16.4.0",
63
63
  "husky": "9.1.7",
64
- "markdown-link-check": "3.14.1",
64
+ "markdown-link-check": "3.14.2",
65
65
  "prettier": "3.6.2"
66
66
  },
67
67
  "publishConfig": {