@cypress/github-action 5.0.9 → 5.2.0

package/README.md

@@ -7,6 +7,7 @@
 - [Basic](#basic)
 - [Explicit version](#explicit-version)
 - Run tests in a given [browser](#browser)
+  - using [Chrome](#chrome)
   - using [Firefox](#firefox)
   - using [Edge](#edge)
   - using [headed mode](#headed)
@@ -15,9 +16,10 @@
 - Run only some [spec files](#specs)
 - Test [project in subfolder](#project)
 - [Record results](#record-test-results-on-cypress-cloud) on Cypress Cloud
+- Specify [auto cancel](#specify-auto-cancel-after-failures) after failures
 - Tag [recordings](#tag-recordings)
-- [Quiet output](#quiet-flag)
 - Store [test artifacts](#artifacts) on GitHub
+- [Quiet output](#quiet-flag)
 - Set Cypress [config values](#config)
 - Use specific [config file](#config-file)
 - Run tests in [parallel](#parallel)
@@ -46,7 +48,7 @@
 
 ```yml
 name: End-to-end tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -87,15 +89,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
@@ -108,17 +111,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
@@ -128,16 +127,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
@@ -153,7 +151,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
@@ -171,7 +169,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
@@ -191,7 +189,7 @@ Specify the env argument with `env` parameter
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -209,7 +207,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
@@ -234,7 +232,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
@@ -265,7 +263,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
@@ -285,7 +283,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
@@ -317,7 +315,7 @@ jobs:
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -345,7 +343,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
@@ -369,7 +367,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
@@ -404,13 +402,46 @@ The recording will have tags as labels on the run.
 
 You can pass multiple tags using commas like `tag: node-10,nightly,staging`.
 
+### Specify auto cancel after failures
+
+Specify the number of failed tests that will cancel a run when using the [Cypress Cloud Auto Cancellation](https://docs.cypress.io/guides/cloud/smart-orchestration#Auto-Cancellation) feature.
+
+This feature requires Cypress 12.6.0 or later and a [Cypress Cloud Business or Enterprise](https://www.cypress.io/cloud/) account.
+
+```yml
+name: Cypress E2E Tests
+on: push
+jobs:
+  cypress-run:
+    runs-on: ubuntu-22.04
+    name: E2E
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v3
+
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Cypress run
+        uses: cypress-io/github-action@v5
+        with:
+          record: true
+          # Cancel the run after 2 failed tests
+          auto-cancel-after-failures: 2
+        env:
+          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+See [Auto Cancellation](https://docs.cypress.io/guides/cloud/smart-orchestration#Auto-Cancellation) for more information.
+
 ### 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
 
 ```yml
 name: Artifacts
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -443,7 +474,7 @@ Specify [configuration](https://docs.cypress.io/guides/references/configuration.
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -466,7 +497,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
@@ -489,9 +520,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
@@ -556,7 +585,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
@@ -575,7 +604,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
@@ -592,7 +621,7 @@ jobs:
 
 ```yml
 name: With server
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -618,7 +647,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
@@ -648,7 +677,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
@@ -705,6 +734,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
@@ -723,7 +760,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
@@ -764,7 +801,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
@@ -804,7 +841,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:
@@ -871,7 +908,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
@@ -934,7 +971,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
@@ -959,7 +996,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
@@ -994,7 +1031,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
@@ -1112,6 +1149,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
@@ -1215,7 +1260,7 @@ If your repository does not have `package.json` or `yarn.json` (maybe it contain
 
 ```yml
 name: included
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -1235,7 +1280,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
@@ -1252,7 +1297,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

package/action.yml

@@ -7,6 +7,9 @@ inputs:
     description: 'Sends test results to Cypress Dashboard'
     required: false
     default: false
+  auto-cancel-after-failures:
+    description: 'Overrides the global Cloud configuration to set the failed test threshold for auto cancellation or to disable auto cancellation when recording to the Cloud (requires Cypress 12.x or later)'
+    required: false
   config:
     description: 'Set configuration values. Separate multiple values with a comma. The values set here override any values set in your configuration file.'
     required: false

package/dist/index.js

@@ -79017,6 +79017,13 @@ const runTestsUsingCommandLine = async () => {
     cmd.push('--config-file')
     cmd.push(quoteArgument(configFileInput))
   }
+  const autoCancelAfterFailures = core.getInput(
+    'auto-cancel-after-failures'
+  )
+  if (autoCancelAfterFailures) {
+    cmd.push('--auto-cancel-after-failures')
+    cmd.push(quoteArgument(autoCancelAfterFailures))
+  }
 
   if (parallel || group) {
     let buildIdVar = null
@@ -79145,6 +79152,12 @@ const runTests = async () => {
     cypressOptions.browser = core.getInput('browser')
   }
 
+  if (core.getInput('auto-cancel-after-failures')) {
+    cypressOptions.autoCancelAfterFailures = core.getInput(
+      'auto-cancel-after-failures'
+    )
+  }
+
   if (core.getInput('env')) {
     cypressOptions.env = core.getInput('env')
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "5.0.9",
+  "version": "5.2.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",