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.

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

Rework CYPRESS_RUN_BINARY instructions #6024

Merged
merged 1 commit into from
Dec 2, 2024

Conversation

MikeMcC399
Copy link
Contributor

@MikeMcC399 MikeMcC399 commented Dec 2, 2024

Issue

Advanced Installation > Run binary includes instructions for using the environment variable CYPRESS_RUN_BINARY to override where the npm module finds the Cypress binary.

  1. The instructions to run Cypress do not work as written. The package manager prefix npx, yarn or pnpm is missing and there is no hint that this would be needed.
  2. There are no instructions about how to unzip the Cypress binary cypress.zip. Depending on how the extract or unzip operation is performed, there may be an extra directory level created. On Linux, for instance, this could mean that it is necessary to set the environment variable to CYPRESS_RUN_BINARY=~/Downloads/cypress/Cypress/Cypress instead of CYPRESS_RUN_BINARY=~/Downloads/Cypress/Cypress. This is quite confusing considering the multiple use of the names cypress and Cypress as directories and Cypress as an executable.
  3. If the unzipped binary is located in a read-only location, then Cypress may fail to verify and therefore fail to run (see issue Cypress fails verification if directory for binary_state.json is read-only cypress#30684). There is no mention of this issue or a possible workaround.
  4. As written, the cautionary message, advising against exporting the CYPRESS_RUN_BINARY environment variable, does not make a lot of sense.

Change

The instructions in Advanced Installation > Run binary for using the environment variable CYPRESS_RUN_BINARY are reworked.

Copy link

netlify bot commented Dec 2, 2024

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 10f606d

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399

This comment was marked as outdated.

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.

Nice!

@jennifer-shehane jennifer-shehane merged commit dacaa03 into cypress-io:main Dec 2, 2024
7 checks passed
@MikeMcC399 MikeMcC399 deleted the rework/run_binary branch December 2, 2024 15:19
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