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.

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

Conversation

MikeMcC399
Copy link
Contributor

Situation

If an attempt is made to run Cypress in CI and the Cypress binary is not present, an error message from notInstalledCI is output:

The cypress npm package is installed, but the Cypress binary is missing.

We expected the binary to be installed here: xxx

Reasons it may be missing:

- You're caching 'node_modules' but are not caching this path: xxx
- You ran 'npm install' at an earlier build step but did not persist: xxx

Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.

Alternatively, you can run 'cypress install' to download the binary again.

https://on.cypress.io/not-installed-ci-error

----------

Platform: linux-x64 (Ubuntu - 24.04)
Cypress Version: 14.3.2

The link
https://on.cypress.io/not-installed-ci-error forwards to
https://docs.cypress.io/app/references/error-messages#A-Cached-Cypress-Binary-Could-not-be-found which refers to
https://docs.cypress.io/app/continuous-integration/overview#Caching

The related texts do not cover the situation where pnpm has not installed the Cypress binary due to:

  1. the workflow caching the pnpm store without disabling the the pnpm sideEffectsCache (default setting is enabled)
  2. use of pnpm >10 where running the Cypress postinstall script is not enabled (default is disabled)

Instructions for configuring pnpm to avoid the above two situations are shown in Get Started > Install Cypress > System requirements > Package Manager > pnpm Configuration.

Change

In https://docs.cypress.io/app/references/error-messages#A-Cached-Cypress-Binary-Could-not-be-found

  • Expand the description to cover the case where the CI workflow is not generally using caches.

  • Add a description to cover the pnpm configuration issues.

Copy link

netlify bot commented May 4, 2025

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 9ed9a08

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399
Copy link
Contributor Author

Preview

image

Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@jennifer-shehane jennifer-shehane merged commit dc4ae29 into cypress-io:main May 7, 2025
5 checks passed
@MikeMcC399 MikeMcC399 deleted the rework/notinstalledci branch May 7, 2025 18:35
jennifer-shehane added a commit that referenced this pull request May 8, 2025
* Add Windows 2025 to supported OS list (#6142)

* New user roles and permissions defined (#6143)

* chore: release 14.3.0 documentation (#6144)

* feat: documentation for the press() command (#6135)

* docs for the press() command, including a callout in the accessibility guide

* add press to TOC

* Move some content around, mention accesiibility

* remove 'focus' note

* Document Keyboard.Keys

* update reference to command

* Update example to be a little more real case

* Add another example of autocomplete with tab

* Add link to keyboard api page

* Fix version number for introduction

* Fix broken link

* alphabetize see also

* Update package.json

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* Fix broken link

* lint

---------

Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* chore: add 14.3.0 changelog to documentation

* Update docs/app/guides/accessibility-testing.mdx

* Update docs/app/references/changelog.mdx

Co-authored-by: Bill Glesias <bglesias@gmail.com>

---------

Co-authored-by: Cacie Prins <cacieprins@users.noreply.github.com>
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* Correct parameter usage for click() in shadow.mdx (#6145)

* Update shadow.mdx

- Update the suggestion to pass 'top' to cy.click() using the options defined in cy.click()'s documentation

* Update shadow.mdx

Add missing quote

* Update shadow.mdx

One-line for prettier reasons

* Correct command syntax (#6148)

Adds the missing `s` to `Cypress.Command.overwrite()`

* extend pnpm config instructions (#6149)

* fix cy.origin() "yielding a value" example (#6152)

* Update results-api.mdx (#6150)

* chore: add 14.3.1 changelog (#6153)

* chore: add 14.3.1 changelog

* Update docs/app/references/changelog.mdx

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* empty commit to rekick build

---------

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* docs: harmonize on injectDocumentDomain removal in future version (#6154)

* Add experimentalSessionAndOrigin removed comment to origin video (#6158)

* Fix "cy.visit() succeeded, but commands are timing out" error example (#6157)

* Cross-link cy.origin and injectDocumentDomain (#6156)

* chore: add cypress 14.3.2 changelog (#6160)

* Change 'add on' to 'premium solution' for UI Cov & a11y products (#6162)

* UI Coverage and Branch Review updates (#6167)

* add AQ links and button space

* use onlinks for demo vids

* update Cypress

* content updates

* content tweaks

* add last images

* lint-fix

* simplify

* add detail view docs and clean up

* lint fix

* Update docs/cloud/get-started/introduction.mdx

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* Update docs/ui-coverage/core-concepts/compare-reports.mdx

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* Update docs/ui-coverage/core-concepts/compare-reports.mdx

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>

* revert cypress version bump

* restore package-lock

* remove yarn lockfile

* Update docs/app/get-started/why-cypress.mdx

Co-authored-by: Tyler Biethman <tbiethman@gmail.com>

* Update docs/cloud/features/branch-review.mdx

Co-authored-by: Tyler Biethman <tbiethman@gmail.com>

* Update docs/cloud/features/branch-review.mdx

Co-authored-by: Tyler Biethman <tbiethman@gmail.com>

---------

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>

* chore: add 14.3.3 changelog (#6171)

* chore: add 14.3.3 changelog

* Update docs/app/references/changelog.mdx

Co-authored-by: Matt Schile <mschile@cypress.io>

---------

Co-authored-by: Matt Schile <mschile@cypress.io>

* Rework instructions for missing Cypress binary in CI (#6170)

* Node.js 18 EOL (#6165)

* Add quoting advice for PowerShell CLI options (#6169)

* Add quoting advice for PowerShell CLI options

* Fix --config typo

Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com>

---------

Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com>

* Bump Cypress Docker versions in examples to Node.js 22.15.0 LTS (#6161)

---------

Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Co-authored-by: danjohansenconsulting <133032924+danjohansenconsulting@users.noreply.github.com>
Co-authored-by: Cacie Prins <cacieprins@users.noreply.github.com>
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Co-authored-by: Matthew Sbar <sbarmatthew@gmail.com>
Co-authored-by: Tim Rayers <tprayers@gmail.com>
Co-authored-by: Emily Wisniewski (Rohrbough) <emilyrohrbough@users.noreply.github.com>
Co-authored-by: Mark Noonan <mark@cypress.io>
Co-authored-by: Tyler Biethman <tbiethman@gmail.com>
Co-authored-by: Matt Schile <mschile@cypress.io>
Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants