Merge branch 'master' into feat/record-in-fork-rev2

Author: MikeMcC399

DEVELOPMENT.md

@@ -17,7 +17,7 @@
 
 ```yml
 name: End-to-end tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: 22.04

README.md

@@ -8,7 +8,7 @@
 - [Explicit version](#explicit-version)
 - Run tests in a given [browser](#browser)
   - using [Firefox](#firefox)
-  - using [Edge](#edge) 
+  - using [Edge](#edge)
   - using [headed mode](#headed)
 - Using [Docker image](#docker-image)
 - Specify [environment variables](#env)
@@ -47,7 +47,7 @@
 
 ```yml
 name: End-to-end tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -92,7 +92,7 @@ Specify the browser name or path with `browser` parameter
 
 ```yml
 name: E2E on Chrome
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -154,7 +154,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 +172,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 +192,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 +210,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 +235,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 +266,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 +286,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 +318,7 @@ jobs:
 
 ```yml
 name: Cypress tests
-on: [push]
+on: push
 jobs:
   cypress-run:
     name: Cypress run
@@ -346,7 +346,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 +370,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 +413,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
@@ -444,7 +444,7 @@ If you don't record the test run on Cypress Cloud, you can still store generated
 
 ```yml
 name: Artifacts
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -477,7 +477,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 +500,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 +523,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 +588,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 +607,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 +624,7 @@ jobs:
 
 ```yml
 name: With server
-on: [push]
+on: push
 jobs:
   cypress-run:
     runs-on: ubuntu-22.04
@@ -652,7 +650,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 +680,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
@@ -757,7 +755,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 +796,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
@@ -905,7 +903,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
@@ -968,7 +966,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 +991,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 +1026,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
@@ -1257,7 +1255,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
@@ -1277,7 +1275,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
@@ -1294,7 +1292,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

docs/MAINTENANCE.md

@@ -0,0 +1,57 @@
+# Maintenance
+
+This document describes updating the [examples](../examples) in this repository to use the latest Cypress version.
+
+## Examples
+
+There are two groups of examples which are used to test and demonstrate the use of [cypress-io/github-action](https://github.com/cypress-io/github-action):
+
+1. The [examples](../examples) directory contains examples of the use of Cypress (Current) [Configuration](https://docs.cypress.io/guides/references/configuration) which applies to Cypress 10 and later.
+
+2. The [examples/v9](../examples/v9) directory contains examples which are set up to use Cypress `9.7.0` which is the last version using [Legacy Configuration](https://docs.cypress.io/guides/references/legacy-configuration) which applies to Cypress 9 and below.
+
+The examples make use of [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/) and [Yarn 1 (Classic)](https://classic.yarnpkg.com/) to define and install the packages being used.
+
+## Prerequisites
+
+- A local system running [Ubuntu](https://ubuntu.com/), [Microsoft Windows](https://www.microsoft.com/windows/) or [Apple macOS](https://www.apple.com/macos/).
+
+- The LTS version of [Node.js](https://nodejs.org/). For convenience of switching to other versions of Node.js, [nvm](https://github.com/nvm-sh/nvm) for unix, macOS and windows WSL. For Windows [nvm-windows](https://github.com/coreybutler/nvm-windows).
+
+- [git](https://git-scm.com/) distributed version control system.
+
+- [npm](https://www.npmjs.com/), which is installed with [Node.js](https://nodejs.org/)
+
+- [pnpm](https://pnpm.io/) installed through:
+
+```bash
+npm install pnpm@latest -g
+```
+
+This needs to be repeated if you change the base node version using nvm.
+
+- [Yarn 1 (Classic)](https://classic.yarnpkg.com/) installed through:
+
+```bash
+npm install yarn@latest -g
+```
+
+Again, this needs to be repeated if you change the base node version using nvm.
+
+- [Visual Studio Code](https://code.visualstudio.com/) or other editor
+
+## Updating examples
+
+When a new version of [Cypress](https://docs.cypress.io/guides/references/changelog) is published, the examples can be updated.
+
+From the root of a local clone of the repository, execute:
+
+```bash
+npm run update:cypress
+```
+
+This updates all [examples](../examples) (except [examples/v9](../examples/v9)) to cypress@latest.
+
+[.github/workflows/example-install-only.yml](../.github/workflows/example-install-only.yml) contains a hard-coded Cypress version number. This can be updated by hand.
+
+After updating the examples locally, they can be committed with git and a pull request opened on GitHub.

package.json

@@ -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",