@cypress/github-action 5.3.0 → 5.4.0

package/README.md

@@ -4,7 +4,8 @@
 
 ## Examples
 
-- [Basic](#basic)
+- [End-to-End](#end-to-end-testing) testing
+- [Component](#component-testing) testing
 - [Explicit version](#explicit-version)
 - Run tests in a given [browser](#browser)
   - using [Chrome](#chrome)
@@ -23,7 +24,7 @@
 - Set Cypress [config values](#config)
 - Use specific [config file](#config-file)
 - Run tests in [parallel](#parallel)
-- Run E2E and [Component tests](#component-tests)
+- Combine [Component and E2E](#component-and-e2e-testing) testing
 - [Build app](#build-app) before running the tests
 - [Start server](#start-server) before running the tests
 - [Start multiple servers](#start-multiple-servers) before running the tests
@@ -34,6 +35,8 @@
 - pass [custom build id](#custom-build-id) when recording to Cypress Cloud
 - generate a [robust custom build id](#robust-custom-build-id) to allow re-running the workflow
 - use different [working-directory](#working-directory)
+- use [Yarn Classic](#yarn-classic)
+- use [Yarn workspaces](#yarn-workspaces)
 - use [custom cache key](#custom-cache-key)
 - run tests on multiple [Node versions](#node-versions)
 - split [install and tests](#split-install-and-tests) into separate jobs
@@ -49,7 +52,7 @@ Current examples contained in this repository are based on Cypress 12.x and can
 
 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
+### End-to-End Testing
 
 ```yml
 name: End-to-end tests
@@ -66,12 +69,37 @@ jobs:
         uses: cypress-io/github-action@v5
 ```
 
-[![Basic example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
+[![End-to-End example](https://github.com/cypress-io/github-action/workflows/example-basic/badge.svg?branch=master)](.github/workflows/example-basic.yml)
 
-The workflow file [.github/workflows/example-basic.yml](.github/workflows/example-basic.yml) shows how Cypress runs on GH Actions using Ubuntu (20 and 22), on Windows, and on Mac without additional OS dependencies necessary.
+The workflow file [example-basic.yml](.github/workflows/example-basic.yml) shows how Cypress runs on GH Actions using Ubuntu (20 and 22), Windows, and macOS without additional OS dependencies necessary.
+
+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.
 
 **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).
 
+### Component Testing
+
+To use [Cypress Component Testing](https://on.cypress.io/component-testing) add `component: true`
+
+```yml
+name: End-to-end tests
+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:
+          component: true
+```
+
+[![Component Testing example](https://github.com/cypress-io/github-action/workflows/example-component-test/badge.svg?branch=master)](.github/workflows/example-component-test.yml)
+
+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.
+
 ### Explicit version
 
 **Best practice:**
@@ -139,7 +167,7 @@ name: Edge
 on: push
 jobs:
   edge:
-    runs-on: windows-latest
+    runs-on: ubuntu-22.04
     name: E2E on Edge
     steps:
       - uses: actions/checkout@v3
@@ -565,25 +593,22 @@ jobs:
 
 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.
 
-### Component tests
+### Component and E2E Testing
 
-You can run [Cypress component tests](https://on.cypress.io/component-testing) in a job separate from E2E tests by adding `component: true`:
+[Component Testing](https://on.cypress.io/guides/overview/why-cypress#Component) and [End-to-End (E2E) Testing](https://on.cypress.io/guides/overview/why-cypress#End-to-end) types can be combined in the same job using separate steps
 
 ```yml
-- name: Run E2E tests 🧪
+- name: Run E2E tests
   uses: cypress-io/github-action@v5
 
-- name: Run Component tests 🧪
+- name: Run Component Testing
   uses: cypress-io/github-action@v5
   with:
     # we have already installed everything
     install: false
-    # to run component tests we need to use "component: true"
     component: true
 ```
 
-See the example project [component-test](examples/component-tests/) and the [example-component-test-workflow](.github/workflows/example-component-test.yml) for more details.
-
 ### Build app
 
 You can run a build step before starting tests
@@ -732,7 +757,7 @@ You can even use your own command (usually by using `npm`, `yarn`, `npx`) to wai
 - uses: cypress-io/github-action@v5
   with:
     start: npm start
-    wait-on: 'npx wait-on --timeout 5000 http://localhost:3000'
+    wait-on: 'npx wait-on --timeout 60000 http://localhost:3000'
 ```
 
 See [example-wait-on.yml](.github/workflows/example-wait-on.yml) workflow file.
@@ -970,6 +995,31 @@ jobs:
 
 See [cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) (legacy) for example.
 
+### Yarn Classic
+
+If a `yarn.lock` file is found, the action uses the [Yarn 1 (Classic)](https://classic.yarnpkg.com/) command `yarn --frozen-lockfile` by default to install dependencies.
+
+```yaml
+name: example-yarn-classic
+on: push
+jobs:
+  yarn-classic:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Cypress run
+        uses: cypress-io/github-action@v5
+        with:
+          working-directory: examples/yarn-classic
+```
+
+See [example-yarn-classic.yml](.github/workflows/example-yarn-classic.yml) for an example.
+
+[![Yarn classic example](https://github.com/cypress-io/github-action/workflows/example-yarn-classic/badge.svg?branch=master)](.github/workflows/example-yarn-classic.yml)
+
+See below under [Yarn Modern](#yarn-modern) (version 2 and later) for instructions on installing dependencies using this later version.
+
 ### Yarn workspaces
 
 This action should discover the Yarn workspaces correctly. For example, see folder [examples/start-and-yarn-workspaces](examples/start-and-yarn-workspaces) and workflow file [example-start-and-yarn-workspaces.yml](.github/workflows/example-start-and-yarn-workspaces.yml)
@@ -1141,11 +1191,9 @@ See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-ex
 | [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
@@ -1154,7 +1202,9 @@ See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-ex
 
 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:
+#### Yarn Modern
+
+The above default `yarn` installation command can be replaced for [Yarn Modern](https://yarnpkg.com/) (Yarn 2 and later) using the `install-command` parameter, for example:
 
 ```yml
 - uses: cypress-io/github-action@v5
@@ -1162,7 +1212,9 @@ The above default `yarn` installation command can be replaced for [Yarn Berry](h
     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.
+#### Minimum Node.js
+
+This action uses several production dependencies. The minimum Node version required to run this action depends on the minimum Node version required by the dependencies.
 
 ## Debugging
 
@@ -1351,7 +1403,7 @@ See the [example-cron.yml](./.github/workflows/example-cron.yml) workflow.
 ### 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. 
+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
@@ -1381,6 +1433,8 @@ See [Releases](https://github.com/cypress-io/github-action/releases) for full de
 | v2      | Cypress runs using the [NPM module API](https://docs.cypress.io/guides/guides/module-api) instead of being started via the command line. |
 | v1      | *This version is no longer runnable in GitHub due to security changes.*                                                                  |
 
+*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.*
+
 ## License
 
 [MIT License](./LICENSE.md)