Skip to content

Commit fb8fd05

Browse files
authored
Add pnpm allow-build configuration information (#6141)
1 parent 0e8c8ae commit fb8fd05

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

Diff for: docs/app/get-started/install-cypress.mdx

+12-9
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ Attempting to use it as a non-root user may result in permissions errors.
135135

136136
:::
137137

138+
If you are using a [Cypress Docker image](../continuous-integration/overview#Cypress-Docker-variants),
139+
you will find a fixed version of Node.js is pre-installed in the image.
140+
You select the Node.js version using the Docker image tag.
141+
138142
### Package Manager
139143

140144
Cypress is [installed](#Install) using one of the following supported package managers:
@@ -146,18 +150,17 @@ Cypress is [installed](#Install) using one of the following supported package ma
146150
| [Yarn (Modern aka berry)](https://yarnpkg.com/) | `4.x` and above | [Yarn Installation](https://yarnpkg.com/getting-started/install) |
147151
| [pnpm](https://pnpm.io/) | `8.x` and above | [pnpm Installation](https://pnpm.io/installation) |
148152

149-
:::caution
150-
151-
<strong>Yarn Configuration</strong>
153+
#### Yarn Configuration
152154

153-
[Yarn (Modern)](https://yarnpkg.com/) configuration using [`nodeLinker: "node-modules"`](https://yarnpkg.com/configuration/yarnrc#nodeLinker)
154-
is preferred. Cypress [Component Testing](/app/core-concepts/testing-types#What-is-Component-Testing) is not currently compatible with the default setting [`nodeLinker: "pnp"`](https://yarnpkg.com/configuration/yarnrc#nodeLinker) which uses [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp).
155+
[Yarn (Modern)](https://yarnpkg.com/) configuration using [nodeLinker: "node-modules"](https://yarnpkg.com/configuration/yarnrc#nodeLinker)
156+
is preferred. Cypress [Component Testing](/app/core-concepts/testing-types#What-is-Component-Testing) is not currently compatible with the default setting [nodeLinker: "pnp"](https://yarnpkg.com/configuration/yarnrc#nodeLinker) which uses [Yarn Plug'n'Play](https://yarnpkg.com/features/pnp).
155157

156-
:::
158+
#### pnpm Configuration
157159

158-
If you are using a [Cypress Docker image](../continuous-integration/overview#Cypress-Docker-variants),
159-
you will find a fixed version of Node.js is pre-installed in the image.
160-
You select the Node.js version using the Docker image tag.
160+
[[email protected]](https://github.com/pnpm/pnpm/releases/tag/v10.0.0) and above require allowlisting `cypress`.
161+
This enables Cypress to execute its `postinstall` script so it can install the Cypress binary into the [binary cache](/app/references/advanced-installation#Binary-cache).
162+
Refer to the [pnpm](https://pnpm.io/) configuration file documentation for additional information.
163+
[[email protected]](https://github.com/pnpm/pnpm/releases/tag/v10.4.0) introduced the CLI add option [--allow-build](https://pnpm.io/cli/add#--allow-build) to add the allowed build configuration directly through the command line.
161164

162165
### Hardware
163166

0 commit comments

Comments
 (0)