@cypress/github-action 6.10.1 → 6.10.3

package/README.md

@@ -157,6 +157,12 @@ Alternatively, to mitigate unforeseen breaks, bind to a specific [tag](https://g
 
 The changes associated with each tag are shown under GitHub's [releases](https://github.com/cypress-io/github-action/releases) list. Refer also to the [CHANGELOG](./CHANGELOG.md) for an overview of major changes.
 
+The workflows in the [examples](./examples/) directory use the latest commit from the repo's current branch. This allows all tests to run in CI before release. If you copy any of the examples to your own repo, you should replace `./` and specify instead the action and version as described above.
+
+```yml
+- uses: ./ # replace with cypress-io/github-action@v6
+```
+
 ### Browser
 
 Specify the browser name or path with the `browser` parameter. The default browser, if none is specified, is the built-in [Electron browser](https://on.cypress.io/guides/guides/launching-browsers#Electron-Browser).
@@ -192,9 +198,9 @@ jobs:
     name: E2E on Chrome for Testing
     steps:
       - uses: actions/checkout@v4
-      - uses: browser-actions/setup-chrome@v1
+      - uses: browser-actions/setup-chrome@v2
         with:
-          chrome-version: 137
+          chrome-version: 140
       - uses: cypress-io/github-action@v6
         with:
           browser: chrome-for-testing
@@ -384,7 +390,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 +405,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
 
@@ -553,7 +563,7 @@ jobs:
     # let's make sure our "app" works on several versions of Node
     strategy:
       matrix:
-        node: [20, 22, 24]
+        node: [20, 22, 24, 25]
     name: E2E on Node v${{ matrix.node }}
     steps:
       - name: Setup Node
@@ -656,7 +666,7 @@ jobs:
       # Install npm dependencies, cache them correctly
       # and run all Cypress tests with `quiet` parameter
       - name: Cypress run
-        uses: ./
+        uses: cypress-io/github-action@v6
         with:
           working-directory: examples/quiet
           quiet: true
@@ -1091,8 +1101,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:
@@ -1159,7 +1169,7 @@ jobs:
 
 The package manager `pnpm` is not pre-installed in [GitHub Actions runner images](https://github.com/actions/runner-images) (unlike `npm` and `yarn`) and so it must be installed in a separate workflow step (see below). If the action finds a `pnpm-lock.yaml` file, it uses the [pnpm](https://pnpm.io/cli/install) command `pnpm install --frozen-lockfile` by default to install dependencies.
 
-The example below follows [pnpm recommendations](https://pnpm.io/continuous-integration#github-actions) for installing pnpm and caching the [pnpm store](https://pnpm.io/cli/store). Follow the [Cypress pnpm configuration instructions](https://on.cypress.io/install#pnpm-Configuration) and apply them to your project, to enable pnpm to install the Cypress binary.
+The example below follows [pnpm recommendations](https://pnpm.io/continuous-integration#github-actions) for installing pnpm and caching the [pnpm store](https://pnpm.io/cli/store). Follow the [Cypress pnpm configuration instructions](https://docs.cypress.io/app/get-started/install-cypress#pnpm-configuration) and apply them to your project, to enable pnpm to install the Cypress binary.
 
 ```yaml
 name: example-basic-pnpm
@@ -1334,7 +1344,7 @@ jobs:
     # let's make sure our "app" works on several versions of Node
     strategy:
       matrix:
-        node: [20, 22, 24]
+        node: [20, 22, 24, 25]
     name: E2E on Node v${{ matrix.node }}
     steps:
       - name: Setup Node
@@ -1368,7 +1378,7 @@ jobs:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        node: [20, 22, 24]
+        node: [20, 22, 24, 25]
     name: E2E on Node v${{ matrix.node }}
     steps:
       - uses: actions/setup-node@v4
@@ -1574,7 +1584,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             |
 | ------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------- |
@@ -1835,7 +1845,7 @@ jobs:
 
 Node.js is required to run this action. The recommended version `v6` supports:
 
-- **Node.js** 20.x, 22.x and 24.x
+- **Node.js** 20.x, 22.x, 24.x and 25.x
 
 and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).
 

package/dist/index.js

@@ -80421,92 +80421,6 @@ function wrappy (fn, cb) {
 }
 
 
-/***/ }),
-
-/***/ 9922:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-const got = __nccwpck_require__(3061)
-const debug = __nccwpck_require__(8237)('@cypress/github-action')
-
-/**
- * A small utility for checking when an URL responds, kind of
- * a poor man's https://www.npmjs.com/package/wait-on. This version
- * is implemented using https://github.com/sindresorhus/got
- */
-const ping = (url, timeout) => {
-  if (!timeout) {
-    throw new Error('Expected timeout in ms')
-  }
-
-  // make copy of the error codes that "got" retries on
-  const errorCodes = [...got.defaults.options.retry.errorCodes]
-  errorCodes.push('ESOCKETTIMEDOUT')
-
-  // we expect the server to respond within a time limit
-  // and if it does not - retry up to total "timeout" duration
-  const individualPingTimeout = Math.min(timeout, 30000)
-
-  // add to the timeout max individual ping timeout
-  // to avoid long-waiting ping from "rolling" over the end
-  // and preventing pinging the last time
-  timeout += individualPingTimeout
-  const limit = Math.ceil(timeout / individualPingTimeout)
-
-  debug(`total ping timeout ${timeout}`)
-  debug(`individual ping timeout ${individualPingTimeout}ms`)
-  debug(`retries limit ${limit}`)
-
-  const start = +new Date()
-  return got(url, {
-    headers: {
-      Accept: 'text/html, application/json, text/plain, */*'
-    },
-    timeout: individualPingTimeout,
-    errorCodes,
-    retry: {
-      limit,
-      calculateDelay({ error, attemptCount }) {
-        if (error) {
-          debug(`got error ${JSON.stringify(error)}`)
-        }
-        const now = +new Date()
-        const elapsed = now - start
-        debug(
-          `${elapsed}ms ${error.method} ${error.host} ${error.code} attempt ${attemptCount}`
-        )
-        if (elapsed > timeout) {
-          console.error(
-            '%s timed out on retry %d of %d, elapsed %dms, limit %dms',
-            url,
-            attemptCount,
-            limit,
-            elapsed,
-            timeout
-          )
-          return 0
-        }
-
-        // if the error code is ECONNREFUSED use shorter timeout
-        // because the server is probably starting
-        if (error.code === 'ECONNREFUSED') {
-          return 1000
-        }
-
-        // default "long" timeout
-        return individualPingTimeout
-      }
-    }
-  }).then(() => {
-    const now = +new Date()
-    const elapsed = now - start
-    debug(`pinging ${url} has finished ok after ${elapsed}ms`)
-  })
-}
-
-module.exports = { ping }
-
-
 /***/ }),
 
 /***/ 9491:
@@ -91897,6 +91811,92 @@ module.exports.As = safeParse
 __webpack_unused_export__ = defaultContentType
 
 
+/***/ }),
+
+/***/ 2851:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+const got = __nccwpck_require__(3061)
+const debug = __nccwpck_require__(8237)('@cypress/github-action')
+
+/**
+ * A small utility for checking when an URL responds, kind of
+ * a poor man's https://www.npmjs.com/package/wait-on. This version
+ * is implemented using https://github.com/sindresorhus/got
+ */
+const ping = (url, timeout) => {
+  if (!timeout) {
+    throw new Error('Expected timeout in ms')
+  }
+
+  // make copy of the error codes that "got" retries on
+  const errorCodes = [...got.defaults.options.retry.errorCodes]
+  errorCodes.push('ESOCKETTIMEDOUT')
+
+  // we expect the server to respond within a time limit
+  // and if it does not - retry up to total "timeout" duration
+  const individualPingTimeout = Math.min(timeout, 30000)
+
+  // add to the timeout max individual ping timeout
+  // to avoid long-waiting ping from "rolling" over the end
+  // and preventing pinging the last time
+  timeout += individualPingTimeout
+  const limit = Math.ceil(timeout / individualPingTimeout)
+
+  debug(`total ping timeout ${timeout}`)
+  debug(`individual ping timeout ${individualPingTimeout}ms`)
+  debug(`retries limit ${limit}`)
+
+  const start = +new Date()
+  return got(url, {
+    headers: {
+      Accept: 'text/html, application/json, text/plain, */*'
+    },
+    timeout: individualPingTimeout,
+    errorCodes,
+    retry: {
+      limit,
+      calculateDelay({ error, attemptCount }) {
+        if (error) {
+          debug(`got error ${JSON.stringify(error)}`)
+        }
+        const now = +new Date()
+        const elapsed = now - start
+        debug(
+          `${elapsed}ms ${error.method} ${error.host} ${error.code} attempt ${attemptCount}`
+        )
+        if (elapsed > timeout) {
+          console.error(
+            '%s timed out on retry %d of %d, elapsed %dms, limit %dms',
+            url,
+            attemptCount,
+            limit,
+            elapsed,
+            timeout
+          )
+          return 0
+        }
+
+        // if the error code is ECONNREFUSED use shorter timeout
+        // because the server is probably starting
+        if (error.code === 'ECONNREFUSED') {
+          return 1000
+        }
+
+        // default "long" timeout
+        return individualPingTimeout
+      }
+    }
+  }).then(() => {
+    const now = +new Date()
+    const elapsed = now - start
+    debug(`pinging ${url} has finished ok after ${elapsed}ms`)
+  })
+}
+
+module.exports = { ping }
+
+
 /***/ }),
 
 /***/ 8570:
@@ -93275,7 +93275,7 @@ const quote = __nccwpck_require__(5427)
 const cliParser = __nccwpck_require__(8604)()
 const findYarnWorkspaceRoot = __nccwpck_require__(6748)
 const debug = __nccwpck_require__(8237)('@cypress/github-action')
-const { ping } = __nccwpck_require__(9922)
+const { ping } = __nccwpck_require__(2851)
 const { SUMMARY_ENV_VAR } = __nccwpck_require__(1327)
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "6.10.1",
+  "version": "6.10.3",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",
@@ -19,7 +19,7 @@
     "format:all:check": "prettier --check .",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
-    "check:markdown-links": "find *.md docs/*.md -print0 | xargs -0 -n1 markdown-link-check",
+    "check:markdown-links": "find *.md docs/*.md -print0 | xargs -0 -n1 markdown-link-check -c markdownLinkConfig.json",
     "update:cypress": "./scripts/update-cypress-latest.sh",
     "prepare": "husky"
   },
@@ -33,6 +33,7 @@
   ],
   "author": "Cypress-io",
   "license": "MIT",
+  "type": "commonjs",
   "bugs": {
     "url": "https://github.com/cypress-io/github-action/issues"
   },
@@ -52,16 +53,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.38.0",
+    "@stylistic/eslint-plugin": "5.5.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.38.0",
+    "eslint-plugin-cypress": "5.2.0",
+    "globals": "16.4.0",
     "husky": "9.1.7",
-    "markdown-link-check": "3.13.7",
-    "prettier": "3.5.3"
+    "markdown-link-check": "3.14.1",
+    "prettier": "3.6.2"
   },
   "publishConfig": {
     "access": "public"