@cypress/github-action 5.1.0 → 5.3.0

package/README.md

@@ -7,8 +7,9 @@
 - [Basic](#basic)
 - [Explicit version](#explicit-version)
 - Run tests in a given [browser](#browser)
+  - using [Chrome](#chrome)
   - using [Firefox](#firefox)
-  - using [Edge](#edge) 
+  - using [Edge](#edge)
   - using [headed mode](#headed)
 - Using [Docker image](#docker-image)
 - Specify [environment variables](#env)
@@ -41,13 +42,18 @@
 - [timeouts](#timeouts) to avoid hanging CI jobs
 - [print Cypress info](#print-cypress-info) like detected browsers
 - [run tests nightly](#nightly-tests) or on any schedule
+- [Suppress test summary](#suppress-test-summary)
 - [more examples](#more-examples)
 
+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.
+
+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.
+
 ### Basic
 
 ```yml
 name: End-to-end tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -88,15 +94,16 @@ By using the full version tag, you will avoid accidentally using a newer version
 
 ### Browser
 
-Specify the browser name or path with `browser` parameter
+Specify the browser name or path with the `browser` parameter. The default browser, if none is specified, is the built-in [Electron browser](https://on.cypress.io/guides/guides/launching-browsers#Electron-Browser).
+
+### Chrome
 
 ```yml
-name: E2E on Chrome
-on: [push]
+name: Chrome
+on: push
 jobs:
-  cypress-run:
+  chrome:
     runs-on: ubuntu-22.04
-    # let's make sure our tests pass on Chrome browser
     name: E2E on Chrome
     steps:
       - uses: actions/checkout@v3
@@ -109,17 +116,13 @@ jobs:
 
 ### Firefox
 
-In order to run Firefox, you need to use non-root user (Firefox security restriction).
-
 ```yml
 name: Firefox
 on: push
 jobs:
   firefox:
     runs-on: ubuntu-22.04
-    container:
-      image: cypress/browsers:node18.12.0-chrome106-ff106
-      options: --user 1001
+    name: E2E on Firefox
     steps:
       - uses: actions/checkout@v3
       - uses: cypress-io/github-action@v5
@@ -129,16 +132,15 @@ jobs:
 
 [![Firefox example](https://github.com/cypress-io/github-action/workflows/example-firefox/badge.svg?branch=master)](.github/workflows/example-firefox.yml)
 
-**Note:** the magical user id `1001` works because it matches permissions settings on the home folder, see issue [#104](https://github.com/cypress-io/github-action/issues/104)
-
 ### Edge
 
 ```yml
 name: Edge
 on: push
 jobs:
-  tests:
+  edge:
     runs-on: windows-latest
+    name: E2E on Edge
     steps:
       - uses: actions/checkout@v3
       - uses: cypress-io/github-action@v5
@@ -154,7 +156,7 @@ Run the browser in headed mode - as of Cypress v8.0 the `cypress run` command ex
 
 ```yml
 name: Chrome headed
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -172,7 +174,7 @@ You can run tests in a GH Action in your Docker container.
 
 ```yml
 name: E2E in custom container
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -192,7 +194,7 @@ Specify the env argument with `env` parameter
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -210,7 +212,7 @@ When passing the environment variables this way, unfortunately due to GitHub Act
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -235,7 +237,7 @@ Specify the [spec files to run](https://docs.cypress.io/guides/guides/command-li
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -266,7 +268,7 @@ Specify the [project to run](https://docs.cypress.io/guides/guides/command-line.
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -286,7 +288,7 @@ For more information, visit [the Cypress command-line docs](https://on.cypress.i
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -318,7 +320,7 @@ jobs:
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -346,7 +348,7 @@ You can provide `quiet` flag for cypress run to silence any Cypress specific out
 
 ```yml
 name: example-quiet
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -370,7 +372,7 @@ You can pass a single or multiple tags when recording a run. For example
 
 ```yml
 name: tags
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -413,7 +415,7 @@ This feature requires Cypress 12.6.0 or later and a [Cypress Cloud Business or E
 
 ```yml
 name: Cypress E2E Tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -440,11 +442,11 @@ See [Auto Cancellation](https://docs.cypress.io/guides/cloud/smart-orchestration
 
 ### Artifacts
 
-If you don't record the test run on Cypress Cloud, you can still store generated videos and screenshots as CI artifacts. See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-example) and the workflow example below
+If you don't record the test run on Cypress Cloud, you can still store generated videos and screenshots as CI artifacts. See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-example) (legacy) and the workflow example below
 
 ```yml
 name: Artifacts
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -477,7 +479,7 @@ Specify [configuration](https://docs.cypress.io/guides/references/configuration.
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -500,7 +502,7 @@ Specify the path to your config file with `config-file` parameter
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -523,9 +525,7 @@ You can spin multiple containers running in parallel using `strategy: matrix` ar
 
 ```yml
 name: Parallel Cypress Tests
-
-on: [push]
-
+on: push
 jobs:
   test:
     name: Cypress run
@@ -590,7 +590,7 @@ You can run a build step before starting tests
 
 ```yml
 name: Build
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -609,7 +609,7 @@ If your tests run against a local server, use `start` parameter, the server will
 
 ```yml
 name: With server
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -626,7 +626,7 @@ jobs:
 
 ```yml
 name: With server
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -652,7 +652,7 @@ You can start multiple server processes. For example, if you have an API to star
 
 ```yml
 name: With servers
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -682,7 +682,7 @@ If you are starting a local server and it takes a while to start, you can add a
 
 ```yml
 name: After server responds
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -739,6 +739,14 @@ See [example-wait-on.yml](.github/workflows/example-wait-on.yml) workflow file.
 
 If this action times out waiting for the server to respond, please see [Debugging](#debugging) section in this README file.
 
+#### `wait-on` with Node.js 18+
+
+Under Node.js version 18 and later, `wait-on` may fail to recognize that a `localhost` server is running. This affects development web servers which do not listen on both IPv4 and IPv6 network stacks.
+
+- Check your server documentation to see if it can be started using `0.0.0.0` (all addresses) and use this if available. If this option is not available or does not resolve the issue then carry on to the next steps:
+- If the action log shows that `wait-on` is failing to connect to `127.0.0.1`, replace `localhost` by `[::1]` (the IPv6 loopback address)
+- If the action log shows that `wait-on` is failing to connect to `::1`, replace `localhost` by `127.0.0.1` (the IPv4 loopback address)
+
 ### Custom install command
 
 If you want to overwrite the install command
@@ -757,7 +765,7 @@ You can prefix the default test command using the `command-prefix` option. This
 
 ```yml
 name: Visual
-on: [push]
+on: push
 jobs:
   e2e:
     runs-on: ubuntu-22.04
@@ -798,7 +806,7 @@ You can overwrite [`ci-build-id`](https://on.cypress.io/parallelization#Linking-
 
 ```yml
 name: Parallel
-on: [push]
+on: push
 jobs:
   test:
     runs-on: ubuntu-22.04
@@ -838,7 +846,7 @@ jobs:
         # take the current commit + timestamp together
         # the typical value would be something like
         # "sha-5d3fe...35d3-time-1620841214"
-        run: echo "::set-output name=value::sha-$GITHUB_SHA-time-$(date +"%s")"
+        run: echo "value=sha-$GITHUB_SHA-time-$(date +"%s")" >> $GITHUB_OUTPUT
   smoke-tests:
     needs: ['prepare']
     steps:
@@ -905,7 +913,7 @@ repo/
 You can specify the `app-test` working directory when running Cypress tests using the `working-directory` parameter
 
 ```yml
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -960,7 +968,7 @@ jobs:
           working-directory: e2e
 ```
 
-See [cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) for example.
+See [cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) (legacy) for example.
 
 ### Yarn workspaces
 
@@ -968,7 +976,7 @@ This action should discover the Yarn workspaces correctly. For example, see fold
 
 ```yaml
 name: example-start-and-yarn-workspaces
-on: [push]
+on: push
 jobs:
   single:
     # the example has Yarn workspace in its "root" folder
@@ -993,7 +1001,7 @@ Sometimes the default cache key does not work. For example, if you cannot share
 
 ```yml
 name: End-to-end tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -1028,7 +1036,7 @@ You can run your tests across multiple Node versions.
 
 ```yml
 name: Node versions
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -1079,7 +1087,7 @@ See [cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-m
 
 ### Custom install
 
-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) for working example.
+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.
 
 ### Install Cypress only
 
@@ -1121,23 +1129,23 @@ jobs:
         timeout-minutes: 5
 ```
 
-See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-example)
+See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-example) (legacy).
 
 ### More examples
 
 <!-- prettier-ignore-start -->
-Name | Description
---- | ---
-[cypress-gh-action-small-example](https://github.com/bahmutov/cypress-gh-action-small-example) | Runs tests and records them on Cypress Cloud
-[cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-example) | uses Yarn, and runs in parallel on several versions of Node, different browsers, and more.
-[cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-monorepo) | splits install and running tests commands, runs Cypress from sub-folder
-[cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) | separate folder for Cypress dependencies
-[cypress-gh-action-split-install](https://github.com/bahmutov/cypress-gh-action-split-install) | only install NPM dependencies, then install and cache Cypress binary yourself
-[test-personal-site](https://github.com/bahmutov/test-personal-site) | Testing an external website every night and by manually clicking a button.
-[cypress-gh-action-changed-files](https://github.com/bahmutov/cypress-gh-action-changed-files) | Shows how to run different Cypress projects depending on changed files
-[cypress-examples](https://github.com/bahmutov/cypress-examples) | Shows separate install job from parallel test jobs
-[cypress-gh-action-split-jobs](https://github.com/bahmutov/cypress-gh-action-split-jobs) | Shows a separate install job with the build step, and another job that runs the tests
-[cypress-react-component-example](https://github.com/bahmutov/cypress-react-component-example) | Run E2E and component tests using this action
+| Name                                                                                                    | Description                                                                               |
+| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| [cypress-gh-action-small-example](https://github.com/bahmutov/cypress-gh-action-small-example) (legacy) | Runs tests and records them on Cypress Cloud                                              |
+| [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 |
+| [cypress-gh-action-monorepo](https://github.com/bahmutov/cypress-gh-action-monorepo)                    | Splits install and running tests commands, runs Cypress from sub-folder                   |
+| [cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) (legacy)       | Has separate folder for Cypress dependencies                                              |
+| [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             |
+| [test-personal-site](https://github.com/bahmutov/test-personal-site) (legacy)                           | Testing an external website every night and by manually clicking a button                 |
+| [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                    |
+| [cypress-examples](https://github.com/bahmutov/cypress-examples)                                        | Shows separate install job from parallel test jobs                                        |
+| [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     |
+| [cypress-react-component-example](https://github.com/bahmutov/cypress-react-component-example) (legacy) | Run E2E and component tests using this action                                             |
 <!-- prettier-ignore-end -->
 
 ## Notes
@@ -1146,6 +1154,14 @@ Name | Description
 
 This action installs local dependencies using lock files. If `yarn.lock` file is found, the install uses `yarn --frozen-lockfile` command. Otherwise it expects to find `package-lock.json` and install using `npm ci` command.
 
+The above default `yarn` installation command can be replaced for [Yarn Berry](https://yarnpkg.com/) (Yarn 2 and later) using the `install-command` parameter, for example:
+
+```yml
+- uses: cypress-io/github-action@v5
+  with:
+    install-command: yarn install
+```
+
 This action uses several production dependencies. The minimum Node version required to run this action depends on the minimum Node required by the dependencies.
 
 ## Debugging
@@ -1245,11 +1261,11 @@ This GH Action sets an output `dashboardUrl` if the run was recorded on [Cypress
 
 ### Docker image
 
-If your repository does not have `package.json` or `yarn.json` (maybe it contains a static site and does not need any dependencies), you can run Cypress tests using `cypress/included:...` [Cypress Docker images](https://github.com/cypress-io/cypress-docker-images/tree/master/included). In that case you don't even need this GH Action, instead use the Docker container and write `cypress run` command like this example from [cypress-gh-action-included](https://github.com/bahmutov/cypress-gh-action-included)
+If your repository does not have `package.json` or `yarn.json` (maybe it contains a static site and does not need any dependencies), you can run Cypress tests using `cypress/included:...` [Cypress Docker images](https://github.com/cypress-io/cypress-docker-images/tree/master/included). In that case you don't even need this GH Action, instead use the Docker container and write `cypress run` command like this example from [cypress-gh-action-included](https://github.com/bahmutov/cypress-gh-action-included) (legacy)
 
 ```yml
 name: included
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -1269,7 +1285,7 @@ If you are NOT using the `build` command in your project, you can run the `cypre
 
 ```yml
 name: info
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -1286,7 +1302,7 @@ If you are already using the `build` parameter, you can split the [installation
 
 ```yml
 name: info
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -1332,6 +1348,27 @@ See the [example-cron.yml](./.github/workflows/example-cron.yml) workflow.
 
 [![cron example](https://github.com/cypress-io/github-action/workflows/example-cron/badge.svg?branch=master)](.github/workflows/example-cron.yml)
 
+### Suppress test summary
+
+The default test summary can be suppressed by using the parameter `publish-summary` and setting its value to `false`.
+Sometimes users want to publish test summary using a specific action. 
+For example, a user running Cypress tests using a matrix and wants to retrieve the test summary for each matrix job and use a specific action that merges reports.
+
+```yml
+name: Example no summary
+on: push
+jobs:
+  cypress-run:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Cypress run
+        uses: cypress-io/github-action@v5
+        with:
+          publish-summary: false
+```
+
 ## Changelog
 
 See [Releases](https://github.com/cypress-io/github-action/releases) for full details of changes.

package/action.yml

@@ -65,6 +65,10 @@ inputs:
   headed:
     description: 'Whether or not to use headed mode'
     required: false
+  publish-summary:
+    description: 'Whether or not to publish job summary'
+    required: false
+    default: true
   spec:
     description: 'Provide a specific specs to run'
     required: false

package/dist/index.js

@@ -79227,7 +79227,8 @@ const runTests = async () => {
 
 // Summary is not available for GitHub Enterprise at the moment
 const isSummaryEnabled = () => {
-  return process.env[SUMMARY_ENV_VAR] !== undefined
+  const isSummaryInput = getInputBool('publish-summary')
+  return process.env[SUMMARY_ENV_VAR] !== undefined && isSummaryInput
 }
 
 const generateSummary = async (testResults) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",
@@ -13,8 +13,8 @@
     "test": "echo \"There are no tests :(\"",
     "build": "ncc build -o dist index.js",
     "format": "prettier --write index.js",
-    "check:markdown": "find *.md -print0 | xargs -0 -n1 markdown-link-check -c md-linkcheck.json",
-    "install-deps": "./scripts/npm-install-examples.sh"
+    "check:markdown": "find *.md docs/*.md -print0 | xargs -0 -n1 markdown-link-check -c md-linkcheck.json",
+    "update:cypress": "./scripts/update-cypress-latest.sh"
   },
   "repository": {
     "type": "git",
@@ -45,7 +45,7 @@
     "quote": "0.4.0"
   },
   "devDependencies": {
-    "@types/node": "18.13.0",
+    "@types/node": "18.14.6",
     "@vercel/ncc": "0.36.1",
     "husky": "7.0.4",
     "markdown-link-check": "3.10.3",