@cypress/github-action 6.10.1 → 6.10.2

package/README.md

@@ -384,7 +384,7 @@ For more information, visit [the Cypress command-line docs](https://on.cypress.i
 
 ### Project
 
-Specify the [project to run](https://docs.cypress.io/guides/guides/command-line.html#cypress-run-project-lt-project-path-gt) with `project` parameter
+Specify the [project to run](https://on.cypress.io/command-line#cypress-run-project-lt-project-path-gt) with the `project` parameter
 
 ```yml
 name: Cypress tests
@@ -399,10 +399,14 @@ jobs:
       - name: Cypress run
         uses: cypress-io/github-action@v6
         with:
-          project: ./some/nested/folder
+          project: ./test-subdirectory
 ```
 
-For more information, visit [the Cypress command-line docs](https://on.cypress.io/command-line#cypress-run-project-lt-project-path-gt).
+The `project` parameter may be used to pass on the location of a sub-directory containing a Cypress configuration file and Cypress tests specs. For more information, visit [the Cypress command-line docs](https://on.cypress.io/command-line#cypress-run-project-lt-project-path-gt).
+
+A package manager lock file, including Cypress, must be provided in the root of the repository so that the action is able to [install Cypress](#installation).
+
+If the parameter [working-directory](#working-directory) is also defined, then this is the location to place the package manager lock file, and the project directory would be a subdirectory of the [working-directory](#working-directory). The `project` parameter location may not be above the level of a specified [working-directory](#working-directory) in the file hierarchy.
 
 ### Record test results on Cypress Cloud
 
@@ -1091,8 +1095,8 @@ repo/
       fixtures/
       support/
     cypress.config.js
-  package.json
-  package-lock.json
+    package.json
+    package-lock.json
 ```
 
 We use `working-directory: app-test` to match the above example directory structure:
@@ -1574,7 +1578,7 @@ There is no equivalent action parameter for the CLI options `help`, `key`, `--no
 
 ### Installation
 
-This action installs local dependencies using lock files. Ensure that exactly one type of lock file is used for each project or working-directory from the following supported package managers:
+This action installs local dependencies using lock files. Ensure that exactly one type of lock file is used at the root of the repo or in each working-directory of a monorepo from the following supported package managers:
 
 | Lock file           | Package Manager                                                                                  | Installation command             |
 | ------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------- |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "6.10.1",
+  "version": "6.10.2",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",
@@ -52,16 +52,16 @@
     "supports-color": "9.3.1"
   },
   "devDependencies": {
-    "@eslint/js": "9.26.0",
-    "@stylistic/eslint-plugin": "4.4.1",
-    "@types/node": "22.13.10",
+    "@eslint/js": "9.31.0",
+    "@stylistic/eslint-plugin": "5.2.0",
+    "@types/node": "24.0.15",
     "@vercel/ncc": "0.38.1",
-    "eslint": "9.26.0",
-    "eslint-plugin-cypress": "4.3.0",
-    "globals": "16.0.0",
+    "eslint": "9.31.0",
+    "eslint-plugin-cypress": "5.1.0",
+    "globals": "16.3.0",
     "husky": "9.1.7",
     "markdown-link-check": "3.13.7",
-    "prettier": "3.5.3"
+    "prettier": "3.6.0"
   },
   "publishConfig": {
     "access": "public"