Skip to content

Rework instructions for missing Cypress binary in CI #6170

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

Merged
merged 3 commits into from
May 7, 2025
Merged

Rework instructions for missing Cypress binary in CI #6170

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02cebb3
Rework instructions for missing Cypress binary in CI
MikeMcC399 May 4, 2025
d59d9b0
Merge branch 'main' into rework/notinstalledci
MikeMcC399 May 5, 2025
9ed9a08
Merge branch 'main' into rework/notinstalledci
MikeMcC399 May 7, 2025
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
19 changes: 14 additions & 5 deletions docs/app/references/error-messages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,9 @@ if you've exhausted all other possibilities.

## CLI Errors

Errors in this section may occur when using the [Cypress command line (CLI)](/app/references/command-line).
They may also apply to running Cypress programmatically through the [Cypress Module API](/app/references/module-api).

### <Icon name="exclamation-triangle" color="red" /> You passed the `--record` flag but did not provide us your Record Key.

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

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

This error occurs in CI when using `cypress run` without a valid Cypress binary
cache installed on the system (on linux that's `~/.cache/Cypress`).
This error occurs in CI when attempting to use `cypress run` or `cypress verify` CLI commands
without having a valid Cypress binary cache installed on the system.

The Cypress binary is downloaded and installed into a [global cache folder](/app/references/advanced-installation#Binary-cache)
with a package manager install command (such as `npm ci`, `npm install`, `yarn install` or `pnpm install`).
The Cypress cache can also be loaded from a CI cache that was saved from a previous CI run.

If you are using pnpm, ensure you are following the [pnpm configuration](/app/get-started/install-cypress#pnpm-Configuration)
instructions, otherwise pnpm may skip the Cypress binary installation.

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

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

Expand Down