Skip to content

Commit

Permalink
docs: recommend CYPRESS_INSTALL_BINARY=0 for cypress/included Docker …
Browse files Browse the repository at this point in the history
…image (#1202)
  • Loading branch information
MikeMcC399 committed Jun 19, 2024
1 parent 2daf074 commit aaca9cc
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,28 @@ Replace the `latest` tag with a specific version image tag from [`cypress/browse

Include `options: --user 1001` to avoid permissions issues.

When using [cypress/included](https://github.com/cypress-io/cypress-docker-images/tree/master/included) Docker images, set the environment variable `CYPRESS_INSTALL_BINARY=0` to suppress saving the Cypress binary cache, otherwise cache restore errors may occur. The example below shows how to do this:

```yml
name: Test with Docker cypress/included
on: push
jobs:
cypress-run:
runs-on: ubuntu-22.04
container:
# Cypress Docker image from https://hub.docker.com/r/cypress/included
# with Cypress globally pre-installed
image: cypress/included:latest
options: --user 1001
steps:
- uses: actions/checkout@v4
- uses: cypress-io/github-action@v6
with:
browser: chrome
env:
CYPRESS_INSTALL_BINARY: 0
```

Refer to [cypress-io/cypress-docker-images](https://github.com/cypress-io/cypress-docker-images) for further information about using Cypress Docker images. Cypress offers the [Cypress Docker Factory](https://github.com/cypress-io/cypress-docker-images/tree/master/factory) to generate additional Docker images with selected components and versions.

[![Docker example](https://github.com/cypress-io/github-action/actions/workflows/example-docker.yml/badge.svg)](.github/workflows/example-docker.yml)
Expand Down

0 comments on commit aaca9cc

Please sign in to comment.