@cypress/github-action 5.6.2 → 5.7.1

package/README.md

@@ -1,6 +1,6 @@
 # cypress-io/github-action [![Action status][ci-badge]][ci-workflow] [![cypress][cloud-badge]][cloud-project] [![renovate-app badge][renovate-badge]][renovate-bot]
 
- > [GitHub Action](https://docs.github.com/en/actions) for running [Cypress](https://www.cypress.io) end-to-end and component tests. Includes npm installation, custom caching and lots of configuration options.
+ > [GitHub Action](https://docs.github.com/en/actions) for running [Cypress](https://www.cypress.io) end-to-end and component tests. Includes npm, pnpm and Yarn installation, custom caching and lots of configuration options.
 
 ## Examples
 
@@ -40,6 +40,7 @@
 - Use [pnpm](#pnpm)
 - Use [Yarn Classic](#yarn-classic)
 - Use [Yarn Modern](#yarn-modern)
+- Use [Yarn Plug'n'Play](#yarn-plugnplay)
 - Use [Yarn workspaces](#yarn-workspaces)
 - Use [custom cache key](#custom-cache-key)
 - Run tests on multiple [Node versions](#node-versions)
@@ -1077,6 +1078,31 @@ See [example-yarn-modern.yml](.github/workflows/example-yarn-modern.yml) for an
 
 [![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 Plug'n'Play
+
+When using [Yarn Modern](https://yarnpkg.com/) (Yarn 2 and later) with [Plug'n'Play](https://yarnpkg.com/features/pnp) enabled, you will need to use the `command` parameter to run [yarn dlx](https://yarnpkg.com/cli/dlx) instead of [npx](https://docs.npmjs.com/cli/v9/commands/npx).
+
+```yaml
+name: example-yarn-modern-pnp
+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-pnp
+          install-command: yarn install
+          command: yarn dlx cypress run
+```
+
+[![Yarn Plug'n'Play example](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml/badge.svg?branch=master)](https://github.com/cypress-io/github-action/actions/workflows/example-yarn-modern-pnp.yml)
+
+**Caution**: using the action parameter `command` causes multiple other parameters to be ignored. [See `command` section for more information.](#custom-test-command)
+
 ### 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)

package/dist/index.js

@@ -74479,7 +74479,7 @@ const noLockFile = () => {
   process.exit(1)
 }
 
-// enforce the same NPM cache folder across different operating systems
+// enforce the same npm cache folder across different operating systems
 const NPM_CACHE_FOLDER = path.join(homeDirectory, '.npm')
 const getNpmCache = () => {
   const o = {}
@@ -74505,7 +74505,7 @@ const getNpmCache = () => {
     o.inputPath = NPM_CACHE_FOLDER
   }
 
-  // use exact restore key to prevent NPM cache from growing
+  // use exact restore key to prevent npm cache from growing
   // https://glebbahmutov.com/blog/do-not-let-npm-cache-snowball/
   o.restoreKeys = o.primaryKey = key
   return o
@@ -74532,21 +74532,21 @@ const getCypressBinaryCache = () => {
 }
 
 const restoreCachedNpm = () => {
-  debug('trying to restore cached NPM modules')
+  debug('trying to restore cached npm modules')
   const NPM_CACHE = getNpmCache()
   return restoreCache([NPM_CACHE.inputPath], NPM_CACHE.primaryKey, [
     NPM_CACHE.restoreKeys
   ]).catch((e) => {
-    console.warn('Restoring NPM cache error: %s', e.message)
+    console.warn('Restoring npm cache error: %s', e.message)
   })
 }
 
 const saveCachedNpm = () => {
-  debug('saving NPM modules')
+  debug('saving npm modules')
   const NPM_CACHE = getNpmCache()
   return saveCache([NPM_CACHE.inputPath], NPM_CACHE.primaryKey).catch(
     (e) => {
-      console.warn('Saving NPM cache error: %s', e.message)
+      console.warn('Saving npm cache error: %s', e.message)
     }
   )
 }
@@ -74584,7 +74584,7 @@ const install = () => {
   // prevent lots of progress messages during install
   core.exportVariable('CI', '1')
   core.exportVariable('CYPRESS_CACHE_FOLDER', CYPRESS_CACHE_FOLDER)
-  // set NPM cache path in case the user has custom install command
+  // set npm cache path in case the user has custom install command
   core.exportVariable('npm_config_cache', NPM_CACHE_FOLDER)
 
   // Note: need to quote found tool to avoid Windows choking on
@@ -74596,7 +74596,7 @@ const install = () => {
   }
 
   if (useYarn()) {
-    debug('installing NPM dependencies using Yarn')
+    debug('installing npm dependencies using Yarn')
     return io.which('yarn', true).then((yarnPath) => {
       debug(`yarn at "${yarnPath}"`)
       return exec.exec(
@@ -74606,7 +74606,7 @@ const install = () => {
       )
     })
   } else if (usePnpm()) {
-    debug('installing NPM dependencies using pnpm')
+    debug('installing npm dependencies using pnpm')
     return io.which('pnpm', true).then((pnpmPath) => {
       debug(`pnpm at "${pnpmPath}"`)
       return exec.exec(
@@ -74616,7 +74616,7 @@ const install = () => {
       )
     })
   } else {
-    debug('installing NPM dependencies')
+    debug('installing npm dependencies')
     return io.which('npm', true).then((npmPath) => {
       debug(`npm at "${npmPath}"`)
       return exec.exec(quote(npmPath), ['ci'], cypressCommandOptions)
@@ -75008,10 +75008,6 @@ const runTests = async () => {
     quiet: getInputBool('quiet'),
     component: getInputBool('component')
   }
-  const cypressModulePath =
-    require.resolve('cypress', { paths: [workingDirectory] }) ||
-    'cypress'
-  const cypress = require(cypressModulePath)
   const runTests = getInputBool('runTests', true)
   const spec = getSpecsList()
 
@@ -75033,7 +75029,12 @@ const runTests = async () => {
     return runTestsUsingCommandLine()
   }
 
-  debug('Running Cypress tests using NPM module API')
+  const cypressModulePath =
+    require.resolve('cypress', { paths: [workingDirectory] }) ||
+    'cypress'
+  const cypress = require(cypressModulePath)
+
+  debug('Running Cypress tests using Module API')
   debug(`requiring cypress dependency, cwd is ${process.cwd()}`)
   debug(`working directory ${workingDirectory}`)
   debug(`resolved cypress ${cypressModulePath}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cypress/github-action",
-  "version": "5.6.2",
+  "version": "5.7.1",
   "description": "GitHub Action for running Cypress end-to-end and component tests",
   "private": false,
   "main": "dist/index.js",