@cypress/github-action 5.3.1 → 5.5.0

package/README.md

@@ -35,6 +35,9 @@
 - 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 Modern](#yarn-modern)
+- 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
@@ -755,7 +758,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.
@@ -993,6 +996,53 @@ 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)
+
+### Yarn Modern
+
+To install dependencies using a `yarn.lock` file from [Yarn Modern](https://yarnpkg.com/) (Yarn 2 and later) you need to override the default [Yarn 1 (Classic)](https://classic.yarnpkg.com/) installation command `yarn --frozen-lockfile`. You can do this by using the `install-command` parameter and specifying `yarn install` for example:
+
+```yaml
+name: example-yarn-modern
+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-modern
+          install-command: yarn install
+```
+
+See [example-yarn-modern.yml](.github/workflows/example-yarn-modern.yml) for an example.
+
+[![Yarn Modern example](https://github.com/cypress-io/github-action/workflows/example-yarn-modern/badge.svg?branch=master)](.github/workflows/example-yarn-modern.yml)
+
 ### 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)
@@ -1164,7 +1214,6 @@ 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     |
@@ -1174,17 +1223,11 @@ See [cypress-gh-action-example](https://github.com/bahmutov/cypress-gh-action-ex
 
 ### Installation
 
-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:
+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. See the [Yarn Modern](#yarn-modern) example for instructions on installing dependencies using this later version.
 
-```yml
-- uses: cypress-io/github-action@v5
-  with:
-    install-command: yarn install
-```
+#### Minimum Node.js
 
-This action uses several production dependencies. The minimum Node version required to run this action depends on the minimum Node required by the dependencies.
+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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "5.3.1",
+  "version": "5.5.0",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",
@@ -44,7 +44,7 @@
     "quote": "0.4.0"
   },
   "devDependencies": {
-    "@types/node": "18.14.6",
+    "@types/node": "18.15.3",
     "@vercel/ncc": "0.36.1",
     "husky": "7.0.4",
     "markdown-link-check": "3.10.3",