@cypress/github-action 3.0.6 → 4.0.0

package/README.md

@@ -4,12 +4,13 @@
 
 ## Examples
 
+- [Cypress 10](#cypress-10)
 - [Basic](#basic)
 - [Explicit version](#explicit-version)
 - Run tests in a given [browser](#browser)
-    * using [Firefox](#firefox)
-    * using [Edge](#edge)
-    * using [headless mode](#headless)
+  - using [Firefox](#firefox)
+  - using [Edge](#edge)
+  - using [headless mode](#headless)
 - Using [Docker image](#docker-image)
 - Specify [environment variables](#env)
 - Run only some [spec files](#specs)
@@ -56,7 +57,7 @@ jobs:
       # Install NPM dependencies, cache them correctly
       # and run all Cypress tests
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
 ```
 
 [![Basic example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
@@ -69,18 +70,18 @@ The workflow file [.github/workflows/example-basic.yml](.github/workflows/exampl
 
 **Best practice:**
 
-Our examples specify the tag of the action to use listing only the major version `@v2`
+Our examples specify the tag of the action to use listing only the major version `@v4`
 
 ```yml
 - name: Cypress run
-  uses: cypress-io/github-action@v2
+  uses: cypress-io/github-action@v4
 ```
 
-When using `cypress-io/github-action@v2` 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:
+When using `cypress-io/github-action@v4` 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:
 
 ```yml
 - name: Cypress run
-  uses: cypress-io/github-action@v2.2.7
+  uses: cypress-io/github-action@v4.x.x
 ```
 
 By using the full version tag, you will avoid accidentally using a newer version of the action.
@@ -99,7 +100,7 @@ jobs:
     name: E2E on Chrome
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           browser: chrome
 ```
@@ -121,7 +122,7 @@ jobs:
       options: --user 1001
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           browser: firefox
 ```
@@ -140,7 +141,7 @@ jobs:
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           browser: edge
 ```
@@ -161,7 +162,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           browser: chrome
           headless: true
@@ -182,7 +183,7 @@ jobs:
     container: cypress/browsers:node12.13.0-chrome78-ff70
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           browser: chrome
 ```
@@ -202,7 +203,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run with env
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           env: host=api.dev.local,port=4222
 ```
@@ -220,7 +221,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run with env
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         env:
           CYPRESS_host: api.dev.local
           CYPRESS_port: 4222
@@ -246,7 +247,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           spec: cypress/integration/spec1.js
 ```
@@ -276,7 +277,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           project: ./some/nested/folder
 ```
@@ -297,7 +298,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           record: true
         env:
@@ -329,7 +330,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           record: true
         env:
@@ -391,7 +392,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           record: true
           tag: node-${{ matrix.node }}
@@ -419,7 +420,7 @@ jobs:
     name: Artifacts
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
       # after the test run completes
       # store videos and any screenshots
       # NOTE: screenshots will be generated only if E2E test failed
@@ -455,7 +456,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           config: pageLoadTimeout=100000,baseUrl=http://localhost:3000
 ```
@@ -478,7 +479,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           config-file: tests/cypress-config.json
 ```
@@ -514,7 +515,7 @@ jobs:
       # because of "record" and "parallel" parameters
       # these containers will load balance all found tests among themselves
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           record: true
           parallel: true
@@ -535,22 +536,22 @@ The Cypress GH Action does not spawn or create any additional containers - it on
 
 ### Component tests
 
-You can run the [Cypress component tests](https://on.cypress.io/component-testing) after running E2E tests by calling the action again with a custom command:
+You can run [Cypress component tests](https://on.cypress.io/component-testing) in a job separate from E2E tests by adding `component: true`:
 
 ```yml
 - name: Run E2E tests 🧪
-  uses: cypress-io/github-action@v2
+  uses: cypress-io/github-action@v4
 
 - name: Run Component tests 🧪
-  uses: cypress-io/github-action@v2
+  uses: cypress-io/github-action@v4
   with:
     # we have already installed everything
     install: false
-    # to run component tests we need to use "cypress run-ct"
-    command: yarn cypress run-ct
+    # to run component tests we need to use "component: true"
+    component: true
 ```
 
-See the example project [cypress-react-component-example](https://github.com/bahmutov/cypress-react-component-example)
+See the example project [component-test](/examples/v10/component-tests/) and the [example-component-test-workflow](.github/workflows/example-component-test.yml) for more details.
 
 ### Build app
 
@@ -566,7 +567,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           build: npm run build
 ```
@@ -585,7 +586,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           start: npm start
 ```
@@ -602,7 +603,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           # Linux and MacOS
           start: npm start
@@ -628,7 +629,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           start: npm run api, npm run web
 ```
@@ -658,7 +659,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           start: npm start
           # quote the url to be safe against YML parsing surprises
@@ -670,7 +671,7 @@ jobs:
 By default, `wait-on` will retry for 60 seconds. You can pass a custom timeout in seconds using `wait-on-timeout`.
 
 ```yml
-- uses: cypress-io/github-action@v2
+- uses: cypress-io/github-action@v4
   with:
     start: npm start
     wait-on: 'http://localhost:8080/status'
@@ -683,7 +684,7 @@ See also [![Webpack Dev Server example](https://github.com/cypress-io/github-act
 You can wait for multiple URLs to respond by separating urls with a comma
 
 ```yml
-- uses: cypress-io/github-action@v2
+- uses: cypress-io/github-action@v4
   with:
     # API runs on port 3050
     # Web server runs on port 8080
@@ -697,7 +698,7 @@ The action will wait for the first url to respond, then will check the second ur
 You can even use your own command (usually by using `npm`, `yarn`, `npx`) to wait for the server to respond. For example, if you want to use [wait-on](https://github.com/jeffbski/wait-on) utility to ping the server and run the Cypress tests after the server responds:
 
 ```yml
-- uses: cypress-io/github-action@v2
+- uses: cypress-io/github-action@v4
   with:
     start: npm start
     wait-on: 'npx wait-on --timeout 5000 http://localhost:3000'
@@ -712,7 +713,7 @@ If this action times out waiting for the server to respond, please see [Debuggin
 If you want to overwrite the install command
 
 ```yml
-- uses: cypress-io/github-action@v2
+- uses: cypress-io/github-action@v4
   with:
     install-command: yarn --frozen-lockfile --silent
 ```
@@ -733,7 +734,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           start: npm start
           # quote the url to be safe against YML parsing surprises
@@ -755,7 +756,7 @@ steps:
     uses: actions/checkout@v2
 
   - name: Custom tests 🧪
-    uses: cypress-io/github-action@v2
+    uses: cypress-io/github-action@v4
     with:
       command: npm run e2e:ci
 ```
@@ -778,7 +779,7 @@ jobs:
         containers: [1, 2, 3]
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           record: true
           parallel: true
@@ -813,7 +814,7 @@ jobs:
     needs: ['prepare']
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           record: true
           parallel: true
@@ -847,7 +848,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           start: npm start
           working-directory: e2e
@@ -891,7 +892,7 @@ jobs:
 
       # Cypress has its own package.json in folder "e2e"
       - name: Install Cypress and run tests
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           working-directory: e2e
 ```
@@ -913,7 +914,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         with:
           working-directory: examples/start-and-yarn-workspaces/workspace-1
           build: yarn run build
@@ -948,7 +949,7 @@ jobs:
       # run Cypress tests and record them under the same run
       # associated with commit SHA and just give a different group name
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           record: true
           group: Tests on Node v${{ matrix.node }}
@@ -977,7 +978,7 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
 ```
 
 [![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)
@@ -997,13 +998,13 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - name: Install dependencies
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           # just perform install
           runTests: false
       - run: yarn lint
       - name: Run e2e tests
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           # we have already installed all dependencies above
           install: false
@@ -1030,7 +1031,7 @@ If the project has many dependencies, but you want to install just Cypress you c
       node_modules
     key: my-cache-${{ runner.os }}-${{ hashFiles('package-lock.json') }}
 - run: npm i cypress
-- uses: cypress-io/github-action@v2
+- uses: cypress-io/github-action@v4
   with:
     install: false
 ```
@@ -1052,7 +1053,7 @@ jobs:
     timeout-minutes: 10
     steps:
       - uses: actions/checkout@v2
-      - uses: cypress-io/github-action@v2
+      - uses: cypress-io/github-action@v4
         # you can specify individual step timeout too
         timeout-minutes: 5
 ```
@@ -1099,7 +1100,7 @@ You can set the environment variable using GitHub UI interface, or in the workfl
 
 ```yml
 - name: Cypress tests with debug logs
-  uses: cypress-io/github-action@v2
+  uses: cypress-io/github-action@v4
   env:
     DEBUG: '@cypress/github-action'
 ```
@@ -1112,7 +1113,7 @@ The above `ACTIONS_STEP_DEBUG` setting enables the debug logs from the action it
 
 ```yml
 - name: Cypress tests with debug logs
-  uses: cypress-io/github-action@v2
+  uses: cypress-io/github-action@v4
   env:
     DEBUG: 'cypress:*'
 ```
@@ -1161,7 +1162,7 @@ This GH Action sets an output `dashboardUrl` if the run was recorded on [Cypress
 
 ```yml
 - name: Cypress tests
-  uses: cypress-io/github-action@v2
+  uses: cypress-io/github-action@v4
   # let's give this action an ID so we can refer
   # to its output values later
   id: cypress
@@ -1216,7 +1217,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           build: npx cypress info
 ```
@@ -1233,14 +1234,14 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress install
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           # just perform install
           runTests: false
       - name: Cypress info
         run: npx cypress info
       - name: Cypress run
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
         with:
           # we have already installed all dependencies above
           install: false
@@ -1264,7 +1265,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Cypress nightly tests 🌃
-        uses: cypress-io/github-action@v2
+        uses: cypress-io/github-action@v4
 ```
 
 See the [example-cron.yml](./.github/workflows/example-cron.yml) workflow.

package/action.yml

@@ -11,9 +11,9 @@ inputs:
     description: 'Set configuration values. Separate multiple values with a comma. The values set here override any values set in your configuration file.'
     required: false
   config-file:
-    description: 'Path to a JSON file where configuration values are set.'
+    description: 'Path to the cypress config file where configuration values are set.'
     required: false
-    default: cypress.json
+    default: ''
   env:
     description: 'Sets Cypress environment variables'
     required: false
@@ -80,6 +80,10 @@ inputs:
   quiet:
     description: 'Whether or not to silence any Cypress specific output from stdout'
     required: false
+  component:
+    description: "Lets the action know that Cypress is running component tests and not e2e tests"
+    required: false
+    default: false
 outputs:
   dashboardUrl:
     description: 'Cypress Dashboard URL if the run was recorded'