Add pnpm v10 install allowlist pnpm.onlyBuiltDependencies instructions

[MikeMcC399]

• closes pnpm v10 blocks Cypress binary installation by default #6069

Issue

[email protected], released Jan 7, 2025 includes a breaking change:

Lifecycle scripts of dependencies are not executed during installation by default!

cypress needs to be added to the allowlist for pnpm life cycle scripts in package.json, for instance using the following:

  "pnpm": {
    "onlyBuiltDependencies": ["cypress"]
  }

Change

The installation instructions for Cypress with pnpm are updated to include references to the pnpm documentation:

• pnpm package.json
• pnpm.onlyBuiltDependencies
• pnpm.onlyBuiltDependenciesFile

Note

Currently, executing npm install pnpm@latest --global installs pnpm@9.

The pnpm installation document instructions for using npm currently lists npm install -g pnpm@latest-10 for pnpm@10.

According to the pnpm maintainer https://github.com/orgs/pnpm/discussions/8945#discussioncomment-11775139 this is for a temporary burn-in period. Sooner or later pnpm@latest will be equivalent to [email protected].

[netlify]

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	f7092f3

[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.

[jennifer-shehane]

@MikeMcC399 This is a lot upfront in prime real estate before showing the install commands. Can we make this a note somehow after the install commands show?

[MikeMcC399]

@jennifer-shehane

This is a lot upfront in prime real estate before showing the install commands.

I agree and I had some misgivings when I submitted this PR.

Can we make this a note somehow after the install commands show?

I don't think there is a clean way to just add this text without doing some restructuring of the page. I will put together some change suggestions for the page in a new issue, so you can comment upfront before any PR gets worked on.

In the meantime I will demote this PR to draft.