Repository navigation
Add workspace support for pnpm #1144
Description
- This is an enhancement suggestion in response to issues Error: Cannot find module 'cypress': fail to run action on pnpm workspace. #1054 and Cypress binary randomly missing with pnpm #1138.
What would you like
When the cypress-io/github-action processes a project with a pnpm-lock.yaml lockfile from the pnmp package manager it should be able to interpret pnpm workspaces correctly and run Cypress from a pnpm workspace, including dependency installation and caching.
For example, the following should work:
- name: Cypress test
uses: cypress-io/github-action@v6
with:
working-directory: examples/start-and-pnpm-workspaces/packages/workspace-1This fails because Cypress can't find pnpm-lock.yaml to install dependencies.
- For pnpm dependency caching see enhancement suggestion Add dependency caching to pnpm #1044.
Why is this needed?
The workspace of a pnpm project does not contain any pnpm-lock.yaml file and cypress-io/github-action does not read and interpret any pnpm-workspace.yaml file in the root of a pnpm project using workspaces. This means that the action needs to be applied twice, once in the root and then again in the workspace in order to run Cypress in a pnpm workspace. (See pnpm workspaces.) This is error prone.
The cypress-io/github-action already provides support for Yarn workspaces. Not providing this functionality for pnpm projects with workspaces is inconsistent.
The benefit for users of pnpm projects with workspaces is that the workflows using GitHub Actions can be written in a more simpler way. This reduces the risk of introducing errors especially with caching the Cypress binary.
Background
pnpm has built-in support for monorepositories (AKA multi-package repositories, multi-project repositories, or monolithic repositories).
pnpm repos using workspaces and Cypress are typically structured similar to the following E2E example:
# repo root
/node_modules
/packages
/package.json
/pnpm-lock.yaml
/pnpm-workspace.yaml
# workspace 1
/packages/ws1
/packages/ws1/cypress/e2e/spec.cy.js
/packages/ws1/node_modules
/packages/ws1/cypress.config.js
/packages/ws1/package.json
# workspace 2
etc.
Other
- PR test: add pnpm workspaces example #1140 added instructions in the README > pnpm workspaces to describe how to handle this configuration without out-of-the-box support. See next section for snapshot of this text:
pnpm workspaces
If you are using pnpm workspaces you need to install dependencies and run Cypress tests in a workspace in separate steps. The snippet below shows this principle.
...
- name: Install dependencies
uses: cypress-io/github-action@v6
with:
working-directory: examples/start-and-pnpm-workspaces
runTests: false
- name: Cypress test
uses: cypress-io/github-action@v6
with:
install: false
working-directory: examples/start-and-pnpm-workspaces/packages/workspace-1
...
See the example project start-and-pnpm-workspaces and the example-start-and-pnpm-workspaces.yml workflow for a full working example including pnpm caching.
Activity
osmestad commentedon Apr 16, 2024
MikeMcC399 commentedon Apr 16, 2024
osmestad commentedon Apr 16, 2024
MikeMcC399 commentedon Apr 16, 2024
misha-erm commentedon May 11, 2024
hello, I've just noticed one more problem with pnpm workspace. After latest release of action it shows that there is cypress '13.9.0' cached but later it fails to find binaries for '13.8.1' as our tests use it. I followed start-and-pnpm-workspaces and it worked like a charm until today )
Seems a bit similar to #971
Thank you 🙇🏻
MikeMcC399 commentedon May 11, 2024
@misha-erm
Please open a new issue if you are asking for help. This issue is for the pnpm workspace support enhancement request, not any bug reports about the existing implementation or documentation.
misha-erm commentedon May 11, 2024
I added a comment there as I thought that might be in scope of "workspace support"
If you think that's not related, I can move it to separate issue, sure
For now I just upgraded local cypress version to match the version installed by the github action. Just was a bit surprised that action can't read correct version from pnpm-lock
MikeMcC399 commentedon May 11, 2024
@misha-erm
I tested start-and-pnpm-workspaces with Cypress
13.8.0in workspace-1 and13.9.0in workspace-2 using the workflow example-start-and-pnpm-workspaces.yml and it worked correctly, installing and caching both versions.If you need to have mixed Cypress versions in your pnpm workspaces and it is not working for you, then we can look at it in a separate issue. We would need to see your workflow and your lock file for that.
misha-erm commentedon May 11, 2024
got it. I will keep an eye on it and if it reproduces again will create new issue with reproduction
MikeMcC399 commentedon May 11, 2024
@misha-erm
birkskyum commentedon Jan 22, 2025
I need cypress to be able to test workspace packages that have dependencies of other workspace packages, like:
"dependencies: {
"mypackage": "workspace:*",
}