@cypress/github-action 7.4.0 → 7.4.2

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 (3) hide show
  1. package/README.md +60 -81
  2. package/dist/index.js +708 -238
  3. package/package.json +8 -8
package/README.md CHANGED
@@ -75,7 +75,6 @@ The following examples demonstrate the actions' functions.
75
75
  - Split [install and tests](#split-install-and-tests) into separate jobs
76
76
  - Split [install and tests](#split-install-and-test-with-artifacts) with artifacts
77
77
  - Use [custom install commands](#custom-install)
78
- - Install [only Cypress](#install-cypress-only) to avoid installing all dependencies
79
78
  - Use [timeouts](#timeouts) to avoid hanging CI jobs
80
79
  - Print [Cypress info](#print-cypress-info) like detected browsers
81
80
  - Run [tests nightly](#nightly-tests) or on any schedule
@@ -101,7 +100,7 @@ jobs:
101
100
  runs-on: ubuntu-24.04
102
101
  steps:
103
102
  - name: Checkout
104
- uses: actions/checkout@v6
103
+ uses: actions/checkout@v7
105
104
  # Install dependencies with caching
106
105
  # and run all Cypress tests
107
106
  - name: Cypress run
@@ -126,7 +125,7 @@ jobs:
126
125
  runs-on: ubuntu-24.04
127
126
  steps:
128
127
  - name: Checkout
129
- uses: actions/checkout@v6
128
+ uses: actions/checkout@v7
130
129
  - name: Cypress run
131
130
  uses: cypress-io/github-action@v7
132
131
  with:
@@ -179,7 +178,7 @@ jobs:
179
178
  runs-on: ubuntu-24.04
180
179
  name: E2E on Chrome
181
180
  steps:
182
- - uses: actions/checkout@v6
181
+ - uses: actions/checkout@v7
183
182
  - uses: cypress-io/github-action@v7
184
183
  with:
185
184
  browser: chrome
@@ -199,7 +198,7 @@ jobs:
199
198
  runs-on: ubuntu-24.04
200
199
  name: E2E on Chrome for Testing
201
200
  steps:
202
- - uses: actions/checkout@v6
201
+ - uses: actions/checkout@v7
203
202
  - uses: browser-actions/setup-chrome@v2
204
203
  with:
205
204
  chrome-version: 140
@@ -220,7 +219,7 @@ jobs:
220
219
  runs-on: ubuntu-24.04
221
220
  name: E2E on Firefox
222
221
  steps:
223
- - uses: actions/checkout@v6
222
+ - uses: actions/checkout@v7
224
223
  - uses: cypress-io/github-action@v7
225
224
  with:
226
225
  browser: firefox
@@ -238,7 +237,7 @@ jobs:
238
237
  runs-on: ubuntu-24.04
239
238
  name: E2E on Edge
240
239
  steps:
241
- - uses: actions/checkout@v6
240
+ - uses: actions/checkout@v7
242
241
  - uses: cypress-io/github-action@v7
243
242
  with:
244
243
  browser: edge
@@ -257,7 +256,7 @@ jobs:
257
256
  cypress-run:
258
257
  runs-on: ubuntu-24.04
259
258
  steps:
260
- - uses: actions/checkout@v6
259
+ - uses: actions/checkout@v7
261
260
  - uses: cypress-io/github-action@v7
262
261
  with:
263
262
  browser: chrome
@@ -280,7 +279,7 @@ jobs:
280
279
  image: cypress/browsers:latest
281
280
  options: --user 1001
282
281
  steps:
283
- - uses: actions/checkout@v6
282
+ - uses: actions/checkout@v7
284
283
  - uses: cypress-io/github-action@v7
285
284
  with:
286
285
  browser: chrome
@@ -304,7 +303,7 @@ jobs:
304
303
  image: cypress/included:latest
305
304
  options: --user 1001
306
305
  steps:
307
- - uses: actions/checkout@v6
306
+ - uses: actions/checkout@v7
308
307
  - uses: cypress-io/github-action@v7
309
308
  with:
310
309
  browser: chrome
@@ -328,7 +327,7 @@ jobs:
328
327
  runs-on: ubuntu-24.04
329
328
  steps:
330
329
  - name: Checkout
331
- uses: actions/checkout@v6
330
+ uses: actions/checkout@v7
332
331
 
333
332
  - name: Cypress run with env
334
333
  uses: cypress-io/github-action@v7
@@ -346,7 +345,7 @@ jobs:
346
345
  runs-on: ubuntu-24.04
347
346
  steps:
348
347
  - name: Checkout
349
- uses: actions/checkout@v6
348
+ uses: actions/checkout@v7
350
349
 
351
350
  - name: Cypress run with env
352
351
  uses: cypress-io/github-action@v7
@@ -371,7 +370,7 @@ jobs:
371
370
  runs-on: ubuntu-24.04
372
371
  steps:
373
372
  - name: Checkout
374
- uses: actions/checkout@v6
373
+ uses: actions/checkout@v7
375
374
 
376
375
  - name: Cypress run with expose
377
376
  uses: cypress-io/github-action@v7
@@ -396,7 +395,7 @@ jobs:
396
395
  runs-on: ubuntu-24.04
397
396
  steps:
398
397
  - name: Checkout
399
- uses: actions/checkout@v6
398
+ uses: actions/checkout@v7
400
399
 
401
400
  - name: Cypress run
402
401
  uses: cypress-io/github-action@v7
@@ -427,7 +426,7 @@ jobs:
427
426
  runs-on: ubuntu-24.04
428
427
  steps:
429
428
  - name: Checkout
430
- uses: actions/checkout@v6
429
+ uses: actions/checkout@v7
431
430
  - name: Cypress run
432
431
  uses: cypress-io/github-action@v7
433
432
  with:
@@ -459,7 +458,7 @@ jobs:
459
458
  runs-on: ubuntu-24.04
460
459
  steps:
461
460
  - name: Checkout
462
- uses: actions/checkout@v6
461
+ uses: actions/checkout@v7
463
462
 
464
463
  - name: Cypress run
465
464
  uses: cypress-io/github-action@v7
@@ -489,7 +488,7 @@ jobs:
489
488
  runs-on: ubuntu-24.04
490
489
  steps:
491
490
  - name: Checkout
492
- uses: actions/checkout@v6
491
+ uses: actions/checkout@v7
493
492
  - name: Cypress run
494
493
  uses: cypress-io/github-action@v7
495
494
  with:
@@ -522,7 +521,7 @@ jobs:
522
521
  runs-on: ubuntu-24.04
523
522
  steps:
524
523
  - name: Checkout
525
- uses: actions/checkout@v6
524
+ uses: actions/checkout@v7
526
525
  - name: Cypress run
527
526
  uses: cypress-io/github-action@v7
528
527
  with:
@@ -560,7 +559,7 @@ jobs:
560
559
  runs-on: ubuntu-24.04
561
560
  steps:
562
561
  - name: Checkout
563
- uses: actions/checkout@v6
562
+ uses: actions/checkout@v7
564
563
 
565
564
  - name: Cypress run
566
565
  uses: cypress-io/github-action@v7
@@ -596,9 +595,9 @@ jobs:
596
595
  name: E2E on Node v${{ matrix.node }}
597
596
  steps:
598
597
  - name: Checkout
599
- uses: actions/checkout@v6
598
+ uses: actions/checkout@v7
600
599
  - name: Install Node.js
601
- uses: actions/setup-node@v6
600
+ uses: actions/setup-node@v7
602
601
  with:
603
602
  node-version: ${{ matrix.node }}
604
603
  - run: node -v
@@ -634,7 +633,7 @@ jobs:
634
633
  name: E2E
635
634
  steps:
636
635
  - name: Checkout
637
- uses: actions/checkout@v6
636
+ uses: actions/checkout@v7
638
637
 
639
638
  - name: Cypress run
640
639
  uses: cypress-io/github-action@v7
@@ -661,7 +660,7 @@ jobs:
661
660
  runs-on: ubuntu-24.04
662
661
  name: Artifacts
663
662
  steps:
664
- - uses: actions/checkout@v6
663
+ - uses: actions/checkout@v7
665
664
  - uses: cypress-io/github-action@v7
666
665
  # after the test run completes store videos and any screenshots
667
666
  - uses: actions/upload-artifact@v7
@@ -690,7 +689,7 @@ jobs:
690
689
  runs-on: ubuntu-24.04
691
690
  steps:
692
691
  - name: Checkout
693
- uses: actions/checkout@v6
692
+ uses: actions/checkout@v7
694
693
  # Install dependencies with caching
695
694
  # and run all Cypress tests with `quiet` parameter
696
695
  - name: Cypress run
@@ -715,7 +714,7 @@ jobs:
715
714
  runs-on: ubuntu-24.04
716
715
  steps:
717
716
  - name: Checkout
718
- uses: actions/checkout@v6
717
+ uses: actions/checkout@v7
719
718
 
720
719
  - name: Cypress run
721
720
  uses: cypress-io/github-action@v7
@@ -738,7 +737,7 @@ jobs:
738
737
  runs-on: ubuntu-24.04
739
738
  steps:
740
739
  - name: Checkout
741
- uses: actions/checkout@v6
740
+ uses: actions/checkout@v7
742
741
 
743
742
  - name: Cypress run
744
743
  uses: cypress-io/github-action@v7
@@ -772,7 +771,7 @@ jobs:
772
771
  containers: [1, 2, 3]
773
772
  steps:
774
773
  - name: Checkout
775
- uses: actions/checkout@v6
774
+ uses: actions/checkout@v7
776
775
 
777
776
  # because of "record" and "parallel" parameters
778
777
  # these containers will load balance all found tests among themselves
@@ -833,7 +832,7 @@ jobs:
833
832
  runs-on: ubuntu-24.04
834
833
  steps:
835
834
  - name: Checkout
836
- uses: actions/checkout@v6
835
+ uses: actions/checkout@v7
837
836
  - name: Cypress run
838
837
  uses: cypress-io/github-action@v7
839
838
  with:
@@ -852,7 +851,7 @@ jobs:
852
851
  runs-on: ubuntu-24.04
853
852
  steps:
854
853
  - name: Checkout
855
- uses: actions/checkout@v6
854
+ uses: actions/checkout@v7
856
855
  - name: Cypress run
857
856
  uses: cypress-io/github-action@v7
858
857
  with:
@@ -871,7 +870,7 @@ jobs:
871
870
  runs-on: ubuntu-24.04
872
871
  steps:
873
872
  - name: Checkout
874
- uses: actions/checkout@v6
873
+ uses: actions/checkout@v7
875
874
  - name: Cypress run
876
875
  uses: cypress-io/github-action@v7
877
876
  with:
@@ -897,7 +896,7 @@ jobs:
897
896
  runs-on: ubuntu-24.04
898
897
  steps:
899
898
  - name: Checkout
900
- uses: actions/checkout@v6
899
+ uses: actions/checkout@v7
901
900
  - name: Cypress run
902
901
  uses: cypress-io/github-action@v7
903
902
  with:
@@ -927,7 +926,7 @@ jobs:
927
926
  runs-on: ubuntu-24.04
928
927
  steps:
929
928
  - name: Checkout
930
- uses: actions/checkout@v6
929
+ uses: actions/checkout@v7
931
930
  - name: Cypress run
932
931
  uses: cypress-io/github-action@v7
933
932
  with:
@@ -1016,7 +1015,7 @@ jobs:
1016
1015
  runs-on: ubuntu-24.04
1017
1016
  steps:
1018
1017
  - name: Checkout
1019
- uses: actions/checkout@v6
1018
+ uses: actions/checkout@v7
1020
1019
  - name: Cypress run
1021
1020
  uses: cypress-io/github-action@v7
1022
1021
  with:
@@ -1043,7 +1042,7 @@ Correct example snippet:
1043
1042
 
1044
1043
  ```yml
1045
1044
  steps:
1046
- - uses: actions/checkout@v6
1045
+ - uses: actions/checkout@v7
1047
1046
  - uses: cypress-io/github-action@v7
1048
1047
  with:
1049
1048
  command: npm run custom-test
@@ -1066,7 +1065,7 @@ jobs:
1066
1065
  # run 3 copies of the current job in parallel
1067
1066
  containers: [1, 2, 3]
1068
1067
  steps:
1069
- - uses: actions/checkout@v6
1068
+ - uses: actions/checkout@v7
1070
1069
  - uses: cypress-io/github-action@v7
1071
1070
  with:
1072
1071
  record: true
@@ -1101,7 +1100,7 @@ jobs:
1101
1100
  smoke-tests:
1102
1101
  needs: ['prepare']
1103
1102
  steps:
1104
- - uses: actions/checkout@v6
1103
+ - uses: actions/checkout@v7
1105
1104
  - uses: cypress-io/github-action@v7
1106
1105
  with:
1107
1106
  record: true
@@ -1141,7 +1140,7 @@ jobs:
1141
1140
  cypress-run:
1142
1141
  runs-on: ubuntu-24.04
1143
1142
  steps:
1144
- - uses: actions/checkout@v6
1143
+ - uses: actions/checkout@v7
1145
1144
  - uses: cypress-io/github-action@v7
1146
1145
  with:
1147
1146
  start: npm start
@@ -1179,7 +1178,7 @@ jobs:
1179
1178
  test:
1180
1179
  runs-on: ubuntu-24.04
1181
1180
  steps:
1182
- - uses: actions/checkout@v6
1181
+ - uses: actions/checkout@v7
1183
1182
  - name: Install root dependencies
1184
1183
  run: npm ci
1185
1184
 
@@ -1212,13 +1211,13 @@ jobs:
1212
1211
  runs-on: ubuntu-24.04
1213
1212
  steps:
1214
1213
  - name: Checkout
1215
- uses: actions/checkout@v6
1214
+ uses: actions/checkout@v7
1216
1215
  - name: Install pnpm
1217
1216
  uses: pnpm/action-setup@v6
1218
1217
  with:
1219
1218
  version: 11
1220
1219
  - name: Install Node.js
1221
- uses: actions/setup-node@v6
1220
+ uses: actions/setup-node@v7
1222
1221
  with:
1223
1222
  node-version: 24
1224
1223
  cache: 'pnpm'
@@ -1272,7 +1271,7 @@ jobs:
1272
1271
  runs-on: ubuntu-24.04
1273
1272
  steps:
1274
1273
  - name: Checkout
1275
- uses: actions/checkout@v6
1274
+ uses: actions/checkout@v7
1276
1275
  - name: Cypress run
1277
1276
  uses: cypress-io/github-action@v7
1278
1277
  with:
@@ -1295,10 +1294,10 @@ jobs:
1295
1294
  runs-on: ubuntu-24.04
1296
1295
  steps:
1297
1296
  - name: Checkout
1298
- uses: actions/checkout@v6
1297
+ uses: actions/checkout@v7
1299
1298
  - run: corepack enable # (experimental and optional)
1300
1299
  - name: Set up Yarn cache
1301
- uses: actions/setup-node@v6
1300
+ uses: actions/setup-node@v7
1302
1301
  with:
1303
1302
  node-version: 24
1304
1303
  cache: yarn
@@ -1329,7 +1328,7 @@ jobs:
1329
1328
  runs-on: ubuntu-24.04
1330
1329
  steps:
1331
1330
  - name: Checkout
1332
- uses: actions/checkout@v6
1331
+ uses: actions/checkout@v7
1333
1332
  - name: Cypress run
1334
1333
  uses: cypress-io/github-action@v7
1335
1334
  with:
@@ -1358,7 +1357,7 @@ jobs:
1358
1357
  # and tests in a subfolder like "workspace-1"
1359
1358
  runs-on: ubuntu-24.04
1360
1359
  steps:
1361
- - uses: actions/checkout@v6
1360
+ - uses: actions/checkout@v7
1362
1361
  - uses: cypress-io/github-action@v7
1363
1362
  with:
1364
1363
  working-directory: examples/start-and-yarn-workspaces/workspace-1
@@ -1390,8 +1389,8 @@ jobs:
1390
1389
  runs-on: ubuntu-24.04
1391
1390
  name:
1392
1391
  steps:
1393
- - uses: actions/checkout@v6
1394
- - uses: actions/setup-node@v6
1392
+ - uses: actions/checkout@v7
1393
+ - uses: actions/setup-node@v7
1395
1394
  with:
1396
1395
  node-version: lts
1397
1396
  cache: 'pnpm'
@@ -1421,9 +1420,9 @@ jobs:
1421
1420
  name: E2E on Node v${{ matrix.node }}
1422
1421
  steps:
1423
1422
  - name: Checkout
1424
- uses: actions/checkout@v6
1423
+ uses: actions/checkout@v7
1425
1424
  - name: Install Node.js
1426
- uses: actions/setup-node@v6
1425
+ uses: actions/setup-node@v7
1427
1426
  with:
1428
1427
  node-version: ${{ matrix.node }}
1429
1428
  # run Cypress tests and record them under the same run
@@ -1457,8 +1456,8 @@ jobs:
1457
1456
  - 26
1458
1457
  name: E2E on Node v${{ matrix.node }}
1459
1458
  steps:
1460
- - uses: actions/checkout@v6
1461
- - uses: actions/setup-node@v6
1459
+ - uses: actions/checkout@v7
1460
+ - uses: actions/setup-node@v7
1462
1461
  with:
1463
1462
  node-version: ${{ matrix.node }}
1464
1463
  - uses: cypress-io/github-action@v7
@@ -1479,7 +1478,7 @@ jobs:
1479
1478
  test:
1480
1479
  runs-on: ubuntu-24.04
1481
1480
  steps:
1482
- - uses: actions/checkout@v6
1481
+ - uses: actions/checkout@v7
1483
1482
  - name: Install dependencies
1484
1483
  uses: cypress-io/github-action@v7
1485
1484
  with:
@@ -1512,7 +1511,7 @@ jobs:
1512
1511
  build:
1513
1512
  runs-on: ubuntu-24.04
1514
1513
  steps:
1515
- - uses: actions/checkout@v6
1514
+ - uses: actions/checkout@v7
1516
1515
  - name: Build app
1517
1516
  uses: cypress-io/github-action@v7
1518
1517
  with:
@@ -1530,7 +1529,7 @@ jobs:
1530
1529
  needs: build
1531
1530
  runs-on: ubuntu-24.04
1532
1531
  steps:
1533
- - uses: actions/checkout@v6
1532
+ - uses: actions/checkout@v7
1534
1533
  - name: Restore build artifacts
1535
1534
  uses: actions/download-artifact@v8
1536
1535
  with:
@@ -1549,26 +1548,6 @@ jobs:
1549
1548
 
1550
1549
  Finally, you might not need this GH Action at all. For example, if you want to split the npm dependencies installation from the Cypress binary installation, then it makes no sense to use this action. Instead you can install and cache Cypress yourself.
1551
1550
 
1552
- ### Install Cypress only
1553
-
1554
- 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.
1555
-
1556
- ```yml
1557
- - uses: actions/checkout@v6
1558
- - uses: actions/cache@v5
1559
- with:
1560
- path: |
1561
- ~/.cache/Cypress
1562
- node_modules
1563
- key: my-cache-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
1564
- - run: npm i cypress
1565
- - uses: cypress-io/github-action@v7
1566
- with:
1567
- install: false
1568
- ```
1569
-
1570
- [![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)
1571
-
1572
1551
  ### Timeouts
1573
1552
 
1574
1553
  You can tell the CI to stop the job or the individual step if it runs for longer then a given time limit. This is a good practice to ensure the hanging process does not accidentally use up all your CI minutes.
@@ -1581,7 +1560,7 @@ jobs:
1581
1560
  # to prevent a hanging process from using all your CI minutes
1582
1561
  timeout-minutes: 10
1583
1562
  steps:
1584
- - uses: actions/checkout@v6
1563
+ - uses: actions/checkout@v7
1585
1564
  - uses: cypress-io/github-action@v7
1586
1565
  # you can specify individual step timeout too
1587
1566
  timeout-minutes: 5
@@ -1624,7 +1603,7 @@ jobs:
1624
1603
  runs-on: ubuntu-24.04
1625
1604
  steps:
1626
1605
  - name: Check out repo
1627
- uses: actions/checkout@v6
1606
+ uses: actions/checkout@v7
1628
1607
  - name: Cypress run # install dependencies and run Cypress E2E tests
1629
1608
  uses: cypress-io/github-action@v7 # replaces CLI cypress run
1630
1609
  with:
@@ -1812,7 +1791,7 @@ jobs:
1812
1791
  runs-on: ubuntu-24.04
1813
1792
  steps:
1814
1793
  - name: Checkout
1815
- uses: actions/checkout@v6
1794
+ uses: actions/checkout@v7
1816
1795
  - name: Cypress run
1817
1796
  uses: cypress-io/github-action@v7
1818
1797
  with:
@@ -1829,7 +1808,7 @@ jobs:
1829
1808
  runs-on: ubuntu-24.04
1830
1809
  steps:
1831
1810
  - name: Checkout
1832
- uses: actions/checkout@v6
1811
+ uses: actions/checkout@v7
1833
1812
  - name: Cypress install
1834
1813
  uses: cypress-io/github-action@v7
1835
1814
  with:
@@ -1860,7 +1839,7 @@ jobs:
1860
1839
  runs-on: ubuntu-24.04
1861
1840
  steps:
1862
1841
  - name: Checkout
1863
- uses: actions/checkout@v6
1842
+ uses: actions/checkout@v7
1864
1843
  - name: Cypress nightly tests 🌃
1865
1844
  uses: cypress-io/github-action@v7
1866
1845
  ```
@@ -1880,7 +1859,7 @@ jobs:
1880
1859
  tests:
1881
1860
  runs-on: ubuntu-24.04
1882
1861
  steps:
1883
- - uses: actions/checkout@v6
1862
+ - uses: actions/checkout@v7
1884
1863
  - name: Cypress headless tests
1885
1864
  uses: cypress-io/github-action@v7
1886
1865
  with:
@@ -1909,7 +1888,7 @@ jobs:
1909
1888
  runs-on: ubuntu-24.04
1910
1889
  steps:
1911
1890
  - name: Checkout
1912
- uses: actions/checkout@v6
1891
+ uses: actions/checkout@v7
1913
1892
  - name: Cypress run
1914
1893
  uses: cypress-io/github-action@v7
1915
1894
  with: