The problem is here: https://github.com/cypress-io/github-action/blob/0c9eccfb5989bd87ea58b5d8cce9a4f0db1a6d67/index.js#L621

The Cypress action runs the above index.js file as a Node script. It does so using NPM.

require.resolve('cypress') throws an error in Yarn 2, because the index.js script is running using NPM, meaning the Plug N Play file (.pnp.cjs) is not loaded.

The index.js file ironically looks for Yarn PNP cache files, but it has no way of using files in that cache. 😂

To bypass this (for now), you can use command-prefix: yarrn dlx to pass the default cypress run command through Yarn to find it through PNP. The code path for command-prefix does not use require.resolve, but this feels like coincidence so I’d ask the repo owners still address this.

I believe to fix this formally, the GitHub action needs to load the .pnp.cjs file before or during executing index.js.

Again, for easy access:

Unblocking yourself

• Add command-prefix: yarn dlx to the action’s with.

Notes for repository owners

• If I’m not mistaken, run your dist/index.js file with Yarn’s PNP file (.pnp.cjs) so that require.resolve finds PNP modules like cypress.

I have this same issue. I don’t run the install command in the cypress-io/github-action@v2, but in a previous workflow run step:

run: yarn install --immutable --immutable-cache

and then later:

      - name: Cypress run
        uses: cypress-io/github-action@v2
        with:
          install: false
          start: yarn start:test
          wait-on: 'http://localhost:3000'
          wait-on-timeout: 200
          browser: chrome
          headless: true
          record: true

This was working previously with yarn, but this is now yarn “berry” (3.0.2).

I am using PnP and a Zero-Installs Yarn setup.

@saseungmin

Please check out Yarn Plug’n’Play and see if it meets your needs. This is new functionality contributed by @PilotConway.

Cypress v10 + Cypress GitHub Action v4 + Yarn v3

Sorry I’m late to upgrading to v4. I managed this dirty workaround:

Before running the cypress-io/github-action, run the following:

1. Setup Node
2. yarn install
3. yarn run cypress:pnp

In your package.json, create the script "cypres:pnp": "node ./scripts/cypress-pnp.cjs".

Create the file ./scripts/cypress-pnp.cjs. If you are using Yarn workspaces, create it in the workspace that’s running cypress.

// running Cypress from root
const { mkdirSync, writeFileSync } = require('fs');

const SPACES = 2;

const PACKAGE_JSON = {
  name: 'cypress',
  version: '0.0.1',
  main: './index.cjs',
  type: 'commonjs',
  peerDependencies: {
    cypress: '*',
  },
};

mkdirSync('./node_modules/cypress', {
  recursive: true,
});

writeFileSync(
  './node_modules/cypress/package.json',
  JSON.stringify(PACKAGE_JSON, null, SPACES),
);

writeFileSync(
  './node_modules/cypress/index.cjs',
  `require('../../.pnp.cjs').setup();
module.exports = require('cypress');`,
);

// running Cypress from packages/package-name workspace:
const { mkdirSync, writeFileSync } = require('fs');

const SPACES = 2;

const PACKAGE_JSON = {
  name: 'cypress',
  version: '0.0.1',
  main: './index.cjs',
  type: 'commonjs',
  peerDependencies: {
    cypress: '*',
  },
};

mkdirSync('./node_modules/cypress', {
  recursive: true,
});

writeFileSync(
  './node_modules/cypress/package.json',
  JSON.stringify(PACKAGE_JSON, null, SPACES),
);

writeFileSync(
  './node_modules/cypress/index.cjs',
  `require('../../../../.pnp.cjs').setup();
module.exports = require('cypress');`,
);

(The only difference between the two is the ../../ before .pnp.cjs for workspaces.)

For the cypress-io/github-action:

1. If you are using with.project for a workspace, move it to with.working-directory.
2. Set with.install to false. Remove with.install-command since we installed in a previous step.
3. Just to be safe, keep with.command-prefix set to yarn dlx.

If time permits this weekend, I’ll package this script up into a Node module to make this easier; but the above copy-paste job should work for now.

Link to proof of concept run where the installation is passing for me.

I’ve had success using:

• Latest Cypress (10.3.0 as of writing this)
• The new Cypress config format (cypress.config.js instead of cypress.json)
• Latest Yarn (3.2.1 as of writing this)
• cypress-io/github-action@v3.1.0

Note that you will need to explicitly set the path to your Cypress config file, as otherwise the 3.1.0 action still looks for cypress.json.

Example action:

- name: Run Cypress with Chrome
  uses: cypress-io/github-action@v3.1.0
  with:
    browser: chrome
    record: true
    config-file: cypress.config.js
    install-command: yarn install --immutable
    command-prefix: yarn dlx

@saseungmin Yes, it worked for me.

• Example GitHub Action run/failure before adding command-prefix: yarn dlx
• Example GitHub Action run/success after adding command-prefix: yarn dlx

Same cannot get it to work. A timeout occurs during pipe run:

Opening Cypress...
[1965:1017/182222.115087:ERROR:node_bindings.cc(278)] Most NODE_OPTIONs are not supported in packaged apps. See documentation for more details.
[1965:1017/182222.115179:ERROR:node_bindings.cc(278)] Most NODE_OPTIONs are not supported in packaged apps. See documentation for more details.
[1965:1017/182224.237041:ERROR:bus.cc(392)] Failed to connect to the bus: Could not parse server address: Unknown address type (examples of valid types are "tcp" and on UNIX "unix")
[1965:1017/182224.237078:ERROR:bus.cc(392)] Failed to connect to the bus: Could not parse server address: Unknown address type (examples of valid types are "tcp" and on UNIX "unix")
[2138:1017/182224.258717:ERROR:gpu_init.cc(441)] Passthrough is not supported, GL is swiftshader
[1965:1017/182224.491841:ERROR:bus.cc(392)] Failed to connect to the bus: Could not parse server address: Unknown address type (examples of valid types are "tcp" and on UNIX "unix")
[1965:1017/182224.516792:ERROR:bus.cc(392)] Failed to connect to the bus: Could not parse server address: Unknown address type (examples of valid types are "tcp" and on UNIX "unix")

.yml

name: CI
on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Get yarn cache directory path
      id: yarn-cache-dir-path    
      run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
      
    - uses: actions/cache@v2
      id: yarn-cache
      with:
        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
        restore-keys: |
          ${{ runner.os }}-yarn-

    - name: Yarn Install if no cache hit
      if: steps.yarn-cache.outputs.cache-hit != 'true'
      run: yarn add --cached

    - name: Eslint
      run: yarn lint
            
    - name: Run Component tests 🧪
      uses: cypress-io/github-action@v2
      with:
        install-command : yarn install --immutable --immutable-cache
        command: yarn cypress run-ct 

@forgo Thank you for your advice! I modified it as you suggested, but it doesn’t work.

  check-e2e-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js 14.x
        uses: actions/setup-node@v1
        with:
          node-version: 14.x

      - name: Install dependencies
        run: yarn install --immutable --immutable-cache

      - name: Cypress run
        uses: cypress-io/github-action@v2
        with:
          install: false
          start: yarn start
          wait-on: 'http://localhost:3000'
          browser: chrome
          headless: true

I’m using PnP and a Zero-Installs Yarn 3.0.2 setup. Anyway, is it impossible to install using yarn berry in Cypress github-action?

@MikeMcC399 @PilotConway

Thank you for finally solving this issue! 🙇‍♂️ I checked that it works perfectly.

Has anybody got this to work with Cypress 10, Yarn 3, and cypress-io/github-action v4?

I can get it working with Cypress 10.8.0, Yarn 3.2.3, and cypress-io/github-action v3.1.0. But I would like to instead use cypress-io/github-action v4.

I was really stuck and that saved me so much time, thanks @CharlesStover ! 🥇

@CharlesStover Awesome!!👏 thanks you!👍