Skip to content

Commit dc4ae29

Browse files
authored
Rework instructions for missing Cypress binary in CI (#6170)
1 parent 787c53f commit dc4ae29

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/app/references/error-messages.mdx

+14-5
Original file line numberDiff line numberDiff line change
@@ -610,6 +610,9 @@ if you've exhausted all other possibilities.
610610

611611
## CLI Errors
612612

613+
Errors in this section may occur when using the [Cypress command line (CLI)](/app/references/command-line).
614+
They may also apply to running Cypress programmatically through the [Cypress Module API](/app/references/module-api).
615+
613616
### <Icon name="exclamation-triangle" color="red" /> You passed the `--record` flag but did not provide us your Record Key.
614617

615618
You may receive this error when trying to run Cypress tests in
@@ -659,12 +662,18 @@ We will automatically apply the record key environment variable.
659662

660663
### <Icon name="exclamation-triangle" color="red" /> A Cached Cypress Binary Could not be found
661664

662-
This error occurs in CI when using `cypress run` without a valid Cypress binary
663-
cache installed on the system (on linux that's `~/.cache/Cypress`).
665+
This error occurs in CI when attempting to use `cypress run` or `cypress verify` CLI commands
666+
without having a valid Cypress binary cache installed on the system.
667+
668+
The Cypress binary is downloaded and installed into a [global cache folder](/app/references/advanced-installation#Binary-cache)
669+
with a package manager install command (such as `npm ci`, `npm install`, `yarn install` or `pnpm install`).
670+
The Cypress cache can also be loaded from a CI cache that was saved from a previous CI run.
671+
672+
If you are using pnpm, ensure you are following the [pnpm configuration](/app/get-started/install-cypress#pnpm-Configuration)
673+
instructions, otherwise pnpm may skip the Cypress binary installation.
664674

665-
To fix this error, follow instructions on
666-
[caching the cypress binary in CI](/app/continuous-integration/overview#Caching),
667-
then bump the version of your CI cache to ensure a clean build.
675+
If you are using CI caches, then review also the recommendations for
676+
[caching the Cypress binary in CI](/app/continuous-integration/overview#Caching).
668677

669678
### <Icon name="exclamation-triangle" color="red" /> Incorrect usage of `--ci-build-id` flag
670679

0 commit comments

Comments
 (0)