Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add troubleshooting for Cypress installation #5928

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Add troubleshooting for Cypress installation #5928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34f20e7
Add troubleshooting for Cypress installation
MikeMcC399 Sep 15, 2024
7617f34
remove blank line
MikeMcC399 Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions docs/guides/references/advanced-installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,79 @@ CYPRESS_INSTALL_BINARY=0 npm install

Now Cypress will skip its install phase once the npm module is installed.

### Troubleshoot installation

The Cypress [Life Cycle script](https://docs.npmjs.com/cli/using-npm/scripts) `postinstall` installs the Cypress binary after the [Cypress npm module](https://www.npmjs.com/package/cypress) has been installed. Package managers however execute the `postinstall` step in the background by default which hides the debug output. Execute `cypress install` separately with [debug logging](./troubleshooting#Log-sources) enabled to view the debug logs.

<Tabs groupId="package-manager"
defaultValue="npm"
values={[
{label: 'npm', value: 'npm'},
{label: 'Yarn', value: 'yarn'},
{label: 'pnpm', value: 'pnpm'},
]}>
<TabItem value="npm">

```shell
CYPRESS_INSTALL_BINARY=0 npm install cypress --save-dev
DEBUG=cypress:cli* npx cypress install
```

</TabItem>
<TabItem value="yarn">

```shell
CYPRESS_INSTALL_BINARY=0 yarn add cypress --dev
DEBUG=cypress:cli* yarn cypress install
```

</TabItem>
<TabItem value="pnpm">

```shell
CYPRESS_INSTALL_BINARY=0 pnpm add --save-dev cypress
DEBUG=cypress:cli* pnpm cypress install
```

</TabItem>
</Tabs>

To set environment variables `CYPRESS_INSTALL_BINARY` and `DEBUG` in Windows CMD or PowerShell terminals, refer to examples in [Print DEBUG Logs](./troubleshooting#Print-DEBUG-logs).

In Continuous Integration (CI) use the following commands to display debug logs from the Cypress binary installation:

<Tabs groupId="package-manager"
defaultValue="npm"
values={[
{label: 'npm', value: 'npm'},
{label: 'Yarn', value: 'yarn'},
{label: 'pnpm', value: 'pnpm'},
]}>
<TabItem value="npm">

```shell
DEBUG=cypress:cli* npm ci --foreground-scripts
```

</TabItem>
<TabItem value="yarn">

```shell
yarn install --frozen-lockfile --ignore-scripts # Yarn v1 Classic only
DEBUG=cypress:cli* yarn cypress install
```

</TabItem>
<TabItem value="pnpm">

```shell
pnpm install --frozen-lockfile --ignore-scripts
DEBUG=cypress:cli* pnpm cypress install
```

</TabItem>
</Tabs>

## Binary cache

As of version `3.0`, Cypress downloads the matching Cypress binary to the global
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/references/troubleshooting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ want to enable them

| Set `DEBUG` to value | To enable debugging |
| -------------------------------- | ------------------------------------------------------------- |
| `cypress:cli` | The top-level command line parsing problems |
| `cypress:cli*` | Top-level command line parsing and binary installation |
| `cypress:server:args` | Incorrect parsed command line arguments |
| `cypress:data-context:sources:*` | Not finding the expected project data |
| `cypress:server:project` | Opening the project |
Expand Down