test: add pnpm workspaces example

[MikeMcC399]

Issue

The Cypress GitHub JavaScript Action (GHA) provides minimum support for projects using the pnpm package manager. It runs pnpm install --frozen-lockfile if it finds a pnpm-lock.yaml lockfile. It however offers no simple out-of-the-box provision for working with pnpm workspaces. There is no logic in GHA to deal with the lack of a lockfile in a pnpm workspace and so GHA is unable to install dependencies directly from the workspace.

• Note also Add dependency caching to pnpm #1044. pnpm dependency caching is not implemented in GHA.

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.

Requirements

An example is needed to show how the Cypress GitHub Action (GHA) can be used with pnpm workspaces to install and cache dependencies including the Cypress binary and run Cypress tests in a selected workspace.

Example structure

The action is run twice. Once to install dependencies and a second time to run Cypress tests.

1. cypress-io/github-action is run in the root of the pnpm workspace example with the option runTests set to false. This installs all dependencies in all workspaces and caches the Cypress binary cache.
2. cypress-io/github-action is then run in a selected pnpm workspace using the option working_directory set to the workspace directory with the option install set to false. Cypress is able to run because the node_modules directory is populated from the previous step, and because the Cypress binary is also available in the cache.

The example also includes caching of the pnpm store, like the non-workspace example for pnpm.

Additions

The example includes

1. a new directory examples/start-and-pnpm-workspaces
2. a new workflow .github/workflows/example-start-and-pnpm-workspaces.yml
3. a new entry in the README file under #pnpm-workspaces
4. a new code block in scripts/update-cypress-latest-other.sh to automate updating the new example to the latest version of Cypress.

Verification

GitHub

1. In default branch delete all related caches (Actions > Caches)
2. Run workflow example-start-and-pnpm-workspaces and check for success
3. Check for new caches
   • Linux-pnpm-store-xxx cache of /home/runner/.local/share/pnpm/store/v3 for pnpm store
   • cypress-linux-x64-xxx cache of /home/runner/.cache/Cypres for Cypress binary
   • pnpm-linux-x64-xxx cache of /home/runner/.npm
4. Run workflow again and check for success (existing caches being used successfully)

Local

Execute the following on Ubuntu 22.04 and check for success:

git clean -x -f -d
npm run update:cypress

and repeat

npm run update:cypress

The output should be similar to the following:

updating pnpm workspaces example to Cypress latest version

updating examples/start-and-pnpm-workspaces to cypress@latest
Scope: all 3 workspace projects
Progress: resolved 236, reused 236, downloaded 0, added 0, done
Done in 2.8s
Legend: production dependency, optional only, dev only

[email protected] /home/mike/github/cypress-io/github-action/examples/start-and-pnpm-workspaces/packages/workspace-1

devDependencies:
cypress 13.6.6

[email protected] /home/mike/github/cypress-io/github-action/examples/start-and-pnpm-workspaces/packages/workspace-2

devDependencies:
cypress 13.6.6

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[MikeMcC399]

README Preview

https://github.com/MikeMcC399/github-action/tree/pnpm-workspaces?tab=readme-ov-file#pnpm-workspaces

The badge shows no status since workflow does not yet exist in the master branch.

[jennifer-shehane]

@MikeMcC399 This is great. Thanks for the thorough addition and the explanation on how to test it.

[MikeMcC399]

@jennifer-shehane

This is great. Thanks for the thorough addition and the explanation on how to test it.

There have been a couple of users lately who were struggling to use the action with pnpm workspaces, so that was the motivation to put together a working demo. I will also submit an enhancement request, just so the requirement is documented.

[github-actions]

🎉 This PR is included in version 6.7.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀