Skip to content

Commit aaca9cc

Browse files
authored
docs: recommend CYPRESS_INSTALL_BINARY=0 for cypress/included Docker image (#1202)
1 parent 2daf074 commit aaca9cc

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,28 @@ Replace the `latest` tag with a specific version image tag from [`cypress/browse
243243

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

246+
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:
247+
248+
```yml
249+
name: Test with Docker cypress/included
250+
on: push
251+
jobs:
252+
cypress-run:
253+
runs-on: ubuntu-22.04
254+
container:
255+
# Cypress Docker image from https://hub.docker.com/r/cypress/included
256+
# with Cypress globally pre-installed
257+
image: cypress/included:latest
258+
options: --user 1001
259+
steps:
260+
- uses: actions/checkout@v4
261+
- uses: cypress-io/github-action@v6
262+
with:
263+
browser: chrome
264+
env:
265+
CYPRESS_INSTALL_BINARY: 0
266+
```
267+
246268
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.
247269

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

0 commit comments

Comments
 (0)