@cypress/github-action 5.5.1 → 5.6.0

package/README.md

@@ -35,6 +35,7 @@
 - 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 [pnpm](#pnpm)
 - use [Yarn Classic](#yarn-classic)
 - use [Yarn Modern](#yarn-modern)
 - use [Yarn workspaces](#yarn-workspaces)
@@ -116,7 +117,7 @@ When using `cypress-io/github-action@v5` from your workflow file, you automatica
 
 ```yml
 - name: Cypress run
-  uses: cypress-io/github-action@v5.x.x
+  uses: cypress-io/github-action@v5.1.0
 ```
 
 By using the full version tag, you will avoid accidentally using a newer version of the action.
@@ -408,7 +409,7 @@ jobs:
     # let's make sure our "app" works on several versions of Node
     strategy:
       matrix:
-        node: [14, 16, 18]
+        node: [14, 16, 18, 19]
     name: E2E on Node v${{ matrix.node }}
     steps:
       - name: Setup Node
@@ -434,7 +435,7 @@ The recording will have tags as labels on the run.
 
 ![Tags](images/tags.png)
 
-You can pass multiple tags using commas like `tag: node-10,nightly,staging`.
+You can pass multiple tags using commas like `tag: node-18,nightly,staging`.
 
 ### Specify auto cancel after failures
 
@@ -996,6 +997,31 @@ jobs:
 
 See [cypress-gh-action-subfolders](https://github.com/bahmutov/cypress-gh-action-subfolders) (legacy) for example.
 
+### pnpm
+
+The package manager `pnpm` is not pre-installed in [GitHub Actions runner images](https://github.com/actions/runner-images) (unlike `npm` and `yarn`): to install `pnpm` include [pnpm/action-setup](https://github.com/pnpm/action-setup) in your workflow. 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.
+
+```yaml
+name: example-basic-pnpm
+on: push
+jobs:
+  basic-pnpm:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: latest
+      - name: Cypress run
+        uses: cypress-io/github-action@v5
+        with:
+          working-directory: examples/basic-pnpm
+```
+
+[![pnpm example](https://github.com/cypress-io/github-action/workflows/example-basic-pnpm/badge.svg?branch=master)](.github/workflows/example-basic-pnpm.yml)
+
 ### 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.
@@ -1081,7 +1107,7 @@ jobs:
     # let's make sure our "app" works on several versions of Node
     strategy:
       matrix:
-        node: [14, 16, 18]
+        node: [14, 16, 18, 19]
     name: E2E on Node v${{ matrix.node }}
     steps:
       - name: Setup Node
@@ -1115,7 +1141,7 @@ jobs:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
-        node: [14, 16, 18]
+        node: [14, 16, 18, 19]
     name: E2E on Node v${{ matrix.node }}
     steps:
       - uses: actions/setup-node@v3
@@ -1127,8 +1153,6 @@ jobs:
 
 [![Node versions example](https://github.com/cypress-io/github-action/workflows/example-node-versions/badge.svg?branch=master)](.github/workflows/example-node-versions.yml)
 
-**Note:** because this action uses `npm ci` and `npx` commands, it requires at least Node 8.12 that includes the version of NPM with those commands.
-
 ### Split install and tests
 
 Sometimes you may want to run additional commands between installation and tests. To enable this use the `install` and `runTests` parameters.
@@ -1223,11 +1247,25 @@ 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. See the [Yarn Modern](#yarn-modern) example for instructions on installing dependencies using this later version.
+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:
 
-#### Minimum Node.js
+ | Lock file           | Package Manager                                                                                  | Installation command             |
+ | ------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------- |
+ | `package-lock.json` | [npm](https://docs.npmjs.com/cli/v9/commands/npm-ci)                                             | `npm ci`                         |
+ | `pnpm-lock.yaml`    | [pnpm](https://pnpm.io/cli/install#--frozen-lockfile)                                            | `pnpm install --frozen-lockfile` |
+ | `yarn.lock`         | [Yarn Classic](https://classic.yarnpkg.com/en/docs/cli/install#toc-yarn-install-frozen-lockfile) | `yarn --frozen-lockfile`         |
 
-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.
+See section [Yarn Modern](#yarn-modern) for information about using Yarn version 2 and later.
+
+#### Node.js Support
+
+Node.js is required to run this action. The current version `v5` supports:
+
+- **Node.js** 14.x
+- **Node.js** 16.x
+- **Node.js** 18.x and above
+
+and is generally aligned with [Node.js's release schedule](https://github.com/nodejs/Release).
 
 ## Debugging
 
@@ -1299,7 +1337,9 @@ If you add `workflow_dispatch` event to your workflow, you will be able to start
 
 ### Outputs
 
-This GH Action sets an output `dashboardUrl` if the run was recorded on [Cypress Cloud](https://on.cypress.io/dashboard-introduction), see [action.yml](action.yml). To use this output:
+This action sets a GitHub step output `dashboardUrl` if the run was recorded on [Cypress Cloud](https://on.cypress.io/dashboard-introduction) using the action parameter setting `record: true` (see [Record test results on Cypress Cloud](#record-test-results-on-cypress-cloud)). Note that using a [Custom test command](#custom-test-command) with the `command` parameter overrides the `record` parameter and in this case no `dashboardUrl` step output is saved.
+
+This is an example of using the step output `dashboardUrl`:
 
 ```yml
 - name: Cypress tests
@@ -1308,7 +1348,7 @@ This GH Action sets an output `dashboardUrl` if the run was recorded on [Cypress
   # to its output values later
   id: cypress
   # Continue the build in case of an error, as we need to set the
-  # commit status in the next step, both in case of success and failure
+  # commit status in the next step, both in case of success or failure
   continue-on-error: true
   with:
     record: true
@@ -1322,25 +1362,7 @@ This GH Action sets an output `dashboardUrl` if the run was recorded on [Cypress
 
 [![recording example](https://github.com/cypress-io/github-action/workflows/example-recording/badge.svg?branch=master)](.github/workflows/example-recording.yml)
 
-**Note:** every GH workflow step can have `outcome` and `conclusion` properties. See the documentation at [steps context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context) page. In particular, the `output` value can be `success`, `failure`, `cancelled`, or `skipped` which you can use the next steps that follow.
-
-### Docker image
-
-If your repository does not have `package.json` or `yarn.json` (maybe it contains a static site and does not need any dependencies), you can run Cypress tests using `cypress/included:...` [Cypress Docker images](https://github.com/cypress-io/cypress-docker-images/tree/master/included). In that case you don't even need this GH Action, instead use the Docker container and write `cypress run` command like this example from [cypress-gh-action-included](https://github.com/bahmutov/cypress-gh-action-included) (legacy)
-
-```yml
-name: included
-on: push
-jobs:
-  cypress-run:
-    runs-on: ubuntu-22.04
-    # Docker image with Cypress pre-installed
-    # https://github.com/cypress-io/cypress-docker-images/tree/master/included
-    container: cypress/included:3.8.3
-    steps:
-      - uses: actions/checkout@v3
-      - run: cypress run
-```
+**Note:** every GitHub workflow step can have `outcome` and `conclusion` properties. See the GitHub [Contexts](https://docs.github.com/en/actions/learn-github-actions/contexts) documentation section [steps context](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#steps-context). In particular, the `outcome` or `conclusion` value can be `success`, `failure`, `cancelled`, or `skipped` which you can use in any following steps.
 
 ### Print Cypress info
 
@@ -1441,6 +1463,7 @@ See [Releases](https://github.com/cypress-io/github-action/releases) for full de
 | Version | Changes                                                                                                                                  |
 | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
 | v5      | Examples and workflows additionally use Node.js 18. Use of the end-of-life Node.js version 12 in examples and workflows is removed.      |
+| v4.2.0  | Support for pnpm added.                                                                                      |
 | v4      | Support for Cypress 10 and later versions is added.                                                                                      |
 | v3      | Action runs under Node.js 16 instead of Node.js 12.                                                                                      |
 | v2      | Cypress runs using the [NPM module API](https://docs.cypress.io/guides/guides/module-api) instead of being started via the command line. |

package/dist/index.js

@@ -74454,20 +74454,31 @@ const packageLockFilename = path.join(
 )
 
 const useYarn = () => fs.existsSync(yarnFilename)
-
 const usePnpm = () => fs.existsSync(pnpmLockFilename)
+const useNpm = () => fs.existsSync(packageLockFilename)
 
 const lockHash = () => {
   const lockFilename = useYarn()
     ? yarnFilename
     : usePnpm()
     ? pnpmLockFilename
-    : packageLockFilename
+    : useNpm()
+    ? packageLockFilename
+    : noLockFile()
   const fileHash = hasha.fromFileSync(lockFilename)
   debug(`Hash from file ${lockFilename} is ${fileHash}`)
   return fileHash
 }
 
+const noLockFile = () => {
+  core.error(
+    `Action failed. Missing package manager lockfile. ` +
+      `Expecting one of package-lock.json (npm), pnpm-lock.yaml (pnpm) or yarn.lock (yarn) in working-directory ` +
+      workingDirectory
+  )
+  process.exit(1)
+}
+
 // enforce the same NPM cache folder across different operating systems
 const NPM_CACHE_FOLDER = path.join(homeDirectory, '.npm')
 const getNpmCache = () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "5.5.1",
+  "version": "5.6.0",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",
@@ -12,9 +12,10 @@
   "scripts": {
     "test": "echo \"There are no tests :(\"",
     "build": "ncc build -o dist index.js",
-    "format": "prettier --write index.js",
+    "format": "prettier --write index.js src/ping.js",
     "check:markdown": "find *.md docs/*.md -print0 | xargs -0 -n1 markdown-link-check -c md-linkcheck.json",
-    "update:cypress": "./scripts/update-cypress-latest.sh"
+    "update:cypress": "./scripts/update-cypress-latest.sh",
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -45,18 +46,13 @@
     "supports-color": "9.3.1"
   },
   "devDependencies": {
-    "@types/node": "18.15.3",
+    "@types/node": "18.15.10",
     "@vercel/ncc": "0.36.1",
-    "husky": "7.0.4",
+    "husky": "8.0.3",
     "markdown-link-check": "3.11.0",
     "prettier": "2.8.4"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run format && npm run build && git add index.js dist"
-    }
   }
 }