@cypress/github-action 5.6.0 → 5.6.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 +111 -92
  2. package/action.yml +2 -2
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
- # cypress-io/github-action [![renovate-app badge][renovate-badge]][renovate-bot] [![Action status](https://github.com/cypress-io/github-action/workflows/main/badge.svg?branch=master)](https://github.com/cypress-io/github-action/actions)
1
+ # cypress-io/github-action [![Action status][ci-badge]][ci-workflow] [![cypress][cloud-badge]][cloud-project] [![renovate-app badge][renovate-badge]][renovate-bot]
2
2
 
3
- > [GitHub Action](https://docs.github.com/en/actions) for running [Cypress](https://www.cypress.io) end-to-end and component tests. Includes NPM installation, custom caching and lots of configuration options.
3
+ > [GitHub Action](https://docs.github.com/en/actions) for running [Cypress](https://www.cypress.io) end-to-end and component tests. Includes npm installation, custom caching and lots of configuration options.
4
4
 
5
5
  ## Examples
6
6
 
7
7
  - [End-to-End](#end-to-end-testing) testing
8
8
  - [Component](#component-testing) testing
9
- - [Explicit version](#explicit-version)
9
+ - Select [action version](#action-version)
10
10
  - Run tests in a given [browser](#browser)
11
11
  - using [Chrome](#chrome)
12
12
  - using [Firefox](#firefox)
@@ -17,8 +17,8 @@
17
17
  - Run only some [spec files](#specs)
18
18
  - Test [project in subfolder](#project)
19
19
  - [Record results](#record-test-results-on-cypress-cloud) on Cypress Cloud
20
- - Specify [auto cancel](#specify-auto-cancel-after-failures) after failures
21
20
  - Tag [recordings](#tag-recordings)
21
+ - Specify [auto cancel](#specify-auto-cancel-after-failures) after failures
22
22
  - Store [test artifacts](#artifacts) on GitHub
23
23
  - [Quiet output](#quiet-flag)
24
24
  - Set Cypress [config values](#config)
@@ -29,31 +29,35 @@
29
29
  - [Start server](#start-server) before running the tests
30
30
  - [Start multiple servers](#start-multiple-servers) before running the tests
31
31
  - [Wait for server](#wait-on) to respond before running the tests
32
- - use [custom install command](#custom-install-command)
33
- - use [command prefix](#command-prefix)
34
- - use [own custom test command](#custom-test-command)
35
- - pass [custom build id](#custom-build-id) when recording to Cypress Cloud
36
- - generate a [robust custom build id](#robust-custom-build-id) to allow re-running the workflow
37
- - use different [working-directory](#working-directory)
38
- - use [pnpm](#pnpm)
39
- - use [Yarn Classic](#yarn-classic)
40
- - use [Yarn Modern](#yarn-modern)
41
- - use [Yarn workspaces](#yarn-workspaces)
42
- - use [custom cache key](#custom-cache-key)
43
- - run tests on multiple [Node versions](#node-versions)
44
- - split [install and tests](#split-install-and-tests) into separate jobs
45
- - use [custom install commands](#custom-install)
46
- - install [only Cypress](#install-cypress-only) to avoid installing all dependencies
47
- - [timeouts](#timeouts) to avoid hanging CI jobs
48
- - [print Cypress info](#print-cypress-info) like detected browsers
49
- - [run tests nightly](#nightly-tests) or on any schedule
50
- - [Suppress test summary](#suppress-test-summary)
51
- - [more examples](#more-examples)
32
+ - [`wait-on` with Node.js 18+](#wait-on-with-nodejs-18) workarounds
33
+ - Use [custom install command](#custom-install-command)
34
+ - Use [command prefix](#command-prefix)
35
+ - Use [own custom test command](#custom-test-command)
36
+ - Pass [custom build id](#custom-build-id) when recording to Cypress Cloud
37
+ - Generate a [robust custom build id](#robust-custom-build-id) to allow re-running the workflow
38
+ - Use different [working-directory](#working-directory)
39
+ - Use [subfolders](#subfolders)
40
+ - Use [pnpm](#pnpm)
41
+ - Use [Yarn Classic](#yarn-classic)
42
+ - Use [Yarn Modern](#yarn-modern)
43
+ - Use [Yarn workspaces](#yarn-workspaces)
44
+ - Use [custom cache key](#custom-cache-key)
45
+ - Run tests on multiple [Node versions](#node-versions)
46
+ - Split [install and tests](#split-install-and-tests) into separate jobs
47
+ - Use [custom install commands](#custom-install)
48
+ - Install [only Cypress](#install-cypress-only) to avoid installing all dependencies
49
+ - Use [timeouts](#timeouts) to avoid hanging CI jobs
50
+ - Print [Cypress info](#print-cypress-info) like detected browsers
51
+ - Run [tests nightly](#nightly-tests) or on any schedule
52
+ - Suppress [test summary](#suppress-test-summary)
53
+ - [More examples](#more-examples)
52
54
 
53
55
  Current examples contained in this repository are based on Cypress 12.x and can be found in the [examples](./examples) directory. Examples for [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration) use Cypress `9.7.0` and are kept in the [examples/v9](./examples/v9) directory.
54
56
 
55
57
  Some older **external** examples, linked to by this document, are based solely on Cypress 9 and below and therefore use a [Legacy Configuration](https://on.cypress.io/guides/references/legacy-configuration). These may need modification to be applied to Cypress 10 and later. Each of these external links is listed with a `(legacy)` notation.
56
58
 
59
+ **Note:** this package assumes that [cypress](https://www.npmjs.com/package/cypress) is declared as a development dependency in the [package.json](https://docs.npmjs.com/creating-a-package-json-file) file. The [cypress npm module](https://www.npmjs.com/package/cypress) is required to run Cypress via its [Module API](https://on.cypress.io/module-api).
60
+
57
61
  ### End-to-End Testing
58
62
 
59
63
  ```yml
@@ -65,7 +69,7 @@ jobs:
65
69
  steps:
66
70
  - name: Checkout
67
71
  uses: actions/checkout@v3
68
- # Install NPM dependencies, cache them correctly
72
+ # Install npm dependencies, cache them correctly
69
73
  # and run all Cypress tests
70
74
  - name: Cypress run
71
75
  uses: cypress-io/github-action@v5
@@ -77,8 +81,6 @@ The workflow file [example-basic.yml](.github/workflows/example-basic.yml) shows
77
81
 
78
82
  This workflow uses the default [test type](https://on.cypress.io/guides/overview/why-cypress#Test-types) of [End-to-End (E2E) Testing](https://on.cypress.io/guides/overview/why-cypress#End-to-end). Alternatively, [Component Testing](https://on.cypress.io/guides/overview/why-cypress#Component) can be utilized by referencing the [Component Testing](#component-testing) section below.
79
83
 
80
- **Note:** this package assumes that `cypress` is declared as a development dependency in the `package.json` file. The `cypress` NPM module is required to run Cypress via its [NPM module API](https://on.cypress.io/module-api).
81
-
82
84
  ### Component Testing
83
85
 
84
86
  To use [Cypress Component Testing](https://on.cypress.io/component-testing) add `component: true`
@@ -102,25 +104,27 @@ jobs:
102
104
 
103
105
  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.
104
106
 
105
- ### Explicit version
107
+ ### Action version
106
108
 
107
109
  **Best practice:**
108
110
 
109
- Our examples specify the tag of the action to use listing only the major version `@v5`
111
+ Our examples specify using branch [v5](https://github.com/cypress-io/github-action/tree/v5) which is the action's latest major version:
110
112
 
111
113
  ```yml
112
114
  - name: Cypress run
113
115
  uses: cypress-io/github-action@v5
114
116
  ```
115
117
 
116
- When using `cypress-io/github-action@v5` from your workflow file, you automatically will be using the latest [tagged version from this repository](https://github.com/cypress-io/github-action/tags). If you want to precisely control the version of this module, use the full tag version, for example:
118
+ When using `cypress-io/github-action@v5` from your workflow file, you will automatically use the latest [tag](https://github.com/cypress-io/github-action/tags) from branch [v5](https://github.com/cypress-io/github-action/tree/v5).
119
+
120
+ Alternatively, to mitigate unforeseen breaks, bind to a specific [tag](https://github.com/cypress-io/github-action/tags), for example:
117
121
 
118
122
  ```yml
119
123
  - name: Cypress run
120
124
  uses: cypress-io/github-action@v5.1.0
121
125
  ```
122
126
 
123
- By using the full version tag, you will avoid accidentally using a newer version of the action.
127
+ The changes associated with each tag are shown under GitHub's [releases](https://github.com/cypress-io/github-action/releases) list. Refer also to the [Changelog](#changelog) for an overview of major changes.
124
128
 
125
129
  ### Browser
126
130
 
@@ -279,15 +283,15 @@ jobs:
279
283
  - name: Cypress run
280
284
  uses: cypress-io/github-action@v5
281
285
  with:
282
- spec: cypress/integration/spec1.js
286
+ spec: cypress/e2e/spec1.cy.js
283
287
  ```
284
288
 
285
289
  You can pass multiple specs and wild card patterns using multi-line parameter, see [example-config.yml](./.github/workflows/example-config.yml):
286
290
 
287
291
  ```yml
288
292
  spec: |
289
- cypress/integration/spec-a.js
290
- cypress/**/*-b.js
293
+ cypress/e2e/spec-a.cy.js
294
+ cypress/**/*-b.cy.js
291
295
  ```
292
296
 
293
297
  For more information, visit [the Cypress command-line docs](https://on.cypress.io/command-line#cypress-run-env-lt-env-gt).
@@ -372,30 +376,6 @@ jobs:
372
376
  CYPRESS_PROJECT_ID: ${{ secrets.PROJECT_ID }}
373
377
  ```
374
378
 
375
- ### Quiet flag
376
-
377
- You can provide `quiet` flag for cypress run to silence any Cypress specific output from stdout
378
-
379
- ```yml
380
- name: example-quiet
381
- on: push
382
- jobs:
383
- cypress-run:
384
- runs-on: ubuntu-22.04
385
- steps:
386
- - name: Checkout
387
- uses: actions/checkout@v3
388
- # Install NPM dependencies, cache them correctly
389
- # and run all Cypress tests with `quiet` parameter
390
- - name: Cypress run
391
- uses: ./
392
- with:
393
- working-directory: examples/quiet
394
- quiet: true
395
- ```
396
-
397
- [![example-quiet](https://github.com/cypress-io/github-action/workflows/example-quiet/badge.svg?branch=master)](.github/workflows/example-quiet.yml)
398
-
399
379
  ### Tag recordings
400
380
 
401
381
  You can pass a single or multiple tags when recording a run. For example
@@ -409,7 +389,7 @@ jobs:
409
389
  # let's make sure our "app" works on several versions of Node
410
390
  strategy:
411
391
  matrix:
412
- node: [14, 16, 18, 19]
392
+ node: [16, 18, 19, 20]
413
393
  name: E2E on Node v${{ matrix.node }}
414
394
  steps:
415
395
  - name: Setup Node
@@ -503,6 +483,30 @@ jobs:
503
483
  path: cypress/videos
504
484
  ```
505
485
 
486
+ ### Quiet flag
487
+
488
+ You can provide `quiet` flag for cypress run to silence any Cypress specific output from stdout
489
+
490
+ ```yml
491
+ name: example-quiet
492
+ on: push
493
+ jobs:
494
+ cypress-run:
495
+ runs-on: ubuntu-22.04
496
+ steps:
497
+ - name: Checkout
498
+ uses: actions/checkout@v3
499
+ # Install npm dependencies, cache them correctly
500
+ # and run all Cypress tests with `quiet` parameter
501
+ - name: Cypress run
502
+ uses: ./
503
+ with:
504
+ working-directory: examples/quiet
505
+ quiet: true
506
+ ```
507
+
508
+ [![example-quiet](https://github.com/cypress-io/github-action/workflows/example-quiet/badge.svg?branch=master)](.github/workflows/example-quiet.yml)
509
+
506
510
  ### Config
507
511
 
508
512
  Specify [configuration](https://docs.cypress.io/guides/references/configuration.html) values with `config` parameter
@@ -549,9 +553,9 @@ jobs:
549
553
 
550
554
  ### Parallel
551
555
 
552
- **Note:** Cypress parallelization requires [Cypress Cloud](https://on.cypress.io/dashboard-introduction) account.
556
+ **Note:** Cypress parallelization requires a [Cypress Cloud](https://on.cypress.io/dashboard-introduction) account.
553
557
 
554
- You can spin multiple containers running in parallel using `strategy: matrix` argument. Just add more dummy items to the `containers: [1, 2, ...]` array to spin more free or paid containers. Then use `record` and `parallel` parameters to [load balance tests](https://on.cypress.io/parallelization)
558
+ You can spin multiple containers running in parallel using `strategy: matrix` argument. Just add more dummy items to the `containers: [1, 2, ...]` array to spin more free or paid containers. Then use `record` and `parallel` parameters to [load balance tests](https://on.cypress.io/parallelization).
555
559
 
556
560
  ```yml
557
561
  name: Parallel Cypress Tests
@@ -591,9 +595,11 @@ jobs:
591
595
 
592
596
  ![Parallel run](images/parallel.png)
593
597
 
594
- **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)
598
+ **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).
599
+
600
+ 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.
595
601
 
596
- 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 and into splitting the specs amongst the machines. See the [Cypress parallelization](https://on.cypress.io/parallelization) guide for the explanation.
602
+ 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.
597
603
 
598
604
  ### Component and E2E Testing
599
605
 
@@ -812,7 +818,7 @@ jobs:
812
818
 
813
819
  ### Custom test command
814
820
 
815
- You can overwrite the Cypress run command with your own
821
+ You can overwrite the Cypress run command with your own command.
816
822
 
817
823
  ```yml
818
824
  steps:
@@ -825,6 +831,8 @@ steps:
825
831
  command: npm run e2e:ci
826
832
  ```
827
833
 
834
+ **Caution**: using the action parameter `command` causes multiple other parameters to be ignored including: `auto-cancel-after-failures`, `browser`, `ci-build-id`, `command-prefix`, `component`, `config`, `config-file`, `env`, `group`, `headed`, `parallel`, `project`, `publish-summary`, `quiet`, `record`, `spec` and `tag`.
835
+
828
836
  See [.github/workflows/example-custom-command.yml](.github/workflows/example-custom-command.yml) file.
829
837
 
830
838
  ### Custom build id
@@ -1013,7 +1021,7 @@ jobs:
1013
1021
  - name: Install pnpm
1014
1022
  uses: pnpm/action-setup@v2
1015
1023
  with:
1016
- version: latest
1024
+ version: 7
1017
1025
  - name: Cypress run
1018
1026
  uses: cypress-io/github-action@v5
1019
1027
  with:
@@ -1107,7 +1115,7 @@ jobs:
1107
1115
  # let's make sure our "app" works on several versions of Node
1108
1116
  strategy:
1109
1117
  matrix:
1110
- node: [14, 16, 18, 19]
1118
+ node: [16, 18, 19, 20]
1111
1119
  name: E2E on Node v${{ matrix.node }}
1112
1120
  steps:
1113
1121
  - name: Setup Node
@@ -1141,7 +1149,7 @@ jobs:
1141
1149
  runs-on: ubuntu-22.04
1142
1150
  strategy:
1143
1151
  matrix:
1144
- node: [14, 16, 18, 19]
1152
+ node: [16, 18, 19, 20]
1145
1153
  name: E2E on Node v${{ matrix.node }}
1146
1154
  steps:
1147
1155
  - uses: actions/setup-node@v3
@@ -1184,7 +1192,7 @@ See [cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-m
1184
1192
 
1185
1193
  ### Custom install
1186
1194
 
1187
- 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. See [cypress-gh-action-split-install](https://github.com/bahmutov/cypress-gh-action-split-install) (legacy) for a working example.
1195
+ 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. See [cypress-gh-action-split-install](https://github.com/bahmutov/cypress-gh-action-split-install) (legacy) for a working example.
1188
1196
 
1189
1197
  ### Install Cypress only
1190
1198
 
@@ -1237,7 +1245,7 @@ See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-ex
1237
1245
  | [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-example) (legacy) | Uses Yarn, and runs in parallel on several versions of Node, different browsers, and more |
1238
1246
  | [cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-monorepo) | Splits install and running tests commands, runs Cypress from sub-folder |
1239
1247
  | [cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) (legacy) | Has separate folder for Cypress dependencies |
1240
- | [cypress-gh-action-split-install](https://github.com/bahmutov/cypress-gh-action-split-install) (legacy) | Only install NPM dependencies, then install and cache Cypress binary yourself |
1248
+ | [cypress-gh-action-split-install](https://github.com/bahmutov/cypress-gh-action-split-install) (legacy) | Only install npm dependencies, then install and cache Cypress binary yourself |
1241
1249
  | [cypress-gh-action-changed-files](https://github.com/bahmutov/cypress-gh-action-changed-files) (legacy) | Shows how to run different Cypress projects depending on changed files |
1242
1250
  | [cypress-examples](https://github.com/bahmutov/cypress-examples) | Shows separate install job from parallel test jobs |
1243
1251
  | [cypress-gh-action-split-jobs](https://github.com/bahmutov/cypress-gh-action-split-jobs) (legacy) | Shows a separate install job with the build step, and another job that runs the tests |
@@ -1257,16 +1265,6 @@ This action installs local dependencies using lock files. Ensure that exactly on
1257
1265
 
1258
1266
  See section [Yarn Modern](#yarn-modern) for information about using Yarn version 2 and later.
1259
1267
 
1260
- #### Node.js Support
1261
-
1262
- Node.js is required to run this action. The current version `v5` supports:
1263
-
1264
- - **Node.js** 14.x
1265
- - **Node.js** 16.x
1266
- - **Node.js** 18.x and above
1267
-
1268
- and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).
1269
-
1270
1268
  ## Debugging
1271
1269
 
1272
1270
  This action uses the [debug](https://github.com/visionmedia/debug#readme) module to output additional verbose logs. You can see these debug messages by setting the following environment variable:
@@ -1318,10 +1316,6 @@ pinging url https://example.cypress.io for 30 seconds
1318
1316
  ::debug::pinging https://example.cypress.io has finished ok
1319
1317
  ```
1320
1318
 
1321
- ## Development
1322
-
1323
- Read [DEVELOPMENT.md](DEVELOPMENT.md)
1324
-
1325
1319
  ## More information
1326
1320
 
1327
1321
  - Read our blog post [Drastically Simplify Testing on CI with Cypress GitHub Action](https://www.cypress.io/blog/2019/11/20/drastically-simplify-your-testing-with-cypress-github-action/)
@@ -1456,24 +1450,49 @@ jobs:
1456
1450
  publish-summary: false
1457
1451
  ```
1458
1452
 
1453
+ ## Node.js Support
1454
+
1455
+ Node.js is required to run this action. The current version `v5` supports:
1456
+
1457
+ - **Node.js** 16.x
1458
+ - **Node.js** 18.x and above
1459
+
1460
+ and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).
1461
+
1459
1462
  ## Changelog
1460
1463
 
1461
1464
  See [Releases](https://github.com/cypress-io/github-action/releases) for full details of changes.
1462
1465
 
1463
- | Version | Changes |
1464
- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
1465
- | v5 | Examples and workflows additionally use Node.js 18. Use of the end-of-life Node.js version 12 in examples and workflows is removed. |
1466
- | v4.2.0 | Support for pnpm added. |
1467
- | v4 | Support for Cypress 10 and later versions is added. |
1468
- | v3 | Action runs under Node.js 16 instead of Node.js 12. |
1469
- | v2 | Cypress runs using the [NPM module API](https://docs.cypress.io/guides/guides/module-api) instead of being started via the command line. |
1470
- | v1 | *This version is no longer runnable in GitHub due to security changes.* |
1466
+ | Version | Changes |
1467
+ | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
1468
+ | v5.6.2 | Examples add Node.js 20. End of support and removal of Node.js 14 examples. |
1469
+ | v5.2.0 | Examples add Node.js 19. |
1470
+ | v5.0.0 | Examples add Node.js 18 and remove Node.js 12. |
1471
+ | v4.2.2 | Dependency on GitHub `set-output` workflow command removed. |
1472
+ | v4.2.0 | Support for `pnpm` added. |
1473
+ | v4.0.0 | Support for Cypress 10 and later versions added. |
1474
+ | v3 | Action runs under Node.js 16 instead of Node.js 12. |
1475
+ | v2 | Cypress runs using the [Module API](https://docs.cypress.io/guides/guides/module-api) instead of being started via the command line. |
1476
+ | v1 | *This version is no longer runnable in GitHub due to security changes.* |
1471
1477
 
1472
1478
  *Note: [GitHub announced](https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/) their plan to disable `save-state` and `set-output` commands by May 31, 2023. This will prevent [cypress-io/github-action](https://github.com/cypress-io/github-action) version [v4.2.1](https://github.com/cypress-io/github-action/releases/tag/v4.2.1), and earlier, running after this date since they use `set-output`. Affected users should update to using `v5` of the [cypress-io/github-action](https://github.com/cypress-io/github-action) action before the deadline.*
1473
1479
 
1480
+ ## Contributing
1481
+
1482
+ Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains how to contribute fixes or features to the repo and how to test.
1483
+
1474
1484
  ## License
1475
1485
 
1476
- [MIT License](./LICENSE.md)
1486
+ [![license][license-badge]][license-file]
1487
+
1488
+ This project is licensed under the terms of the [MIT license][license-file].
1477
1489
 
1490
+ <!-- badge links follow -->
1491
+ [ci-badge]: https://github.com/cypress-io/github-action/workflows/main/badge.svg?branch=master
1492
+ [ci-workflow]: https://github.com/cypress-io/github-action/actions/workflows/main.yml
1493
+ [cloud-badge]: https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/3tb7jn/master&style=flat&logo=cypress
1494
+ [cloud-project]: https://cloud.cypress.io/projects/3tb7jn/runs
1478
1495
  [renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
1479
1496
  [renovate-bot]: https://github.com/renovatebot
1497
+ [license-badge]: https://img.shields.io/badge/license-MIT-green.svg
1498
+ [license-file]: ./LICENSE.md
package/action.yml CHANGED
@@ -1,7 +1,7 @@
1
1
  # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions
2
2
  name: 'Cypress.io'
3
- description: 'GitHub Action for running Cypress end-to-end tests'
4
- author: 'Gleb Bahmutov'
3
+ description: 'GitHub Action for running Cypress end-to-end and component tests'
4
+ author: 'Cypress-io'
5
5
  inputs:
6
6
  record:
7
7
  description: 'Sends test results to Cypress Dashboard'
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cypress/github-action",
3
- "version": "5.6.0",
3
+ "version": "5.6.2",
4
4
  "description": "GitHub Action for running Cypress end-to-end and component tests",
5
5
  "private": false,
6
6
  "main": "dist/index.js",
@@ -25,7 +25,7 @@
25
25
  "actions",
26
26
  "cypress-io"
27
27
  ],
28
- "author": "Gleb Bahmutov <gleb@cypress.io>",
28
+ "author": "Cypress-io",
29
29
  "license": "MIT",
30
30
  "bugs": {
31
31
  "url": "https://github.com/cypress-io/github-action/issues"
@@ -46,10 +46,10 @@
46
46
  "supports-color": "9.3.1"
47
47
  },
48
48
  "devDependencies": {
49
- "@types/node": "18.15.10",
49
+ "@types/node": "18.16.1",
50
50
  "@vercel/ncc": "0.36.1",
51
51
  "husky": "8.0.3",
52
- "markdown-link-check": "3.11.0",
52
+ "markdown-link-check": "3.11.1",
53
53
  "prettier": "2.8.4"
54
54
  },
55
55
  "publishConfig": {