Skip to content

Update Docker use description in GitHub Actions #6173

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 1 commit into from
May 8, 2025
Merged

Update Docker use description in GitHub Actions #6173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 26 additions & 14 deletions docs/app/continuous-integration/github-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,20 @@ Cypress offers various
[Docker Images](https://github.com/cypress-io/cypress-docker-images) for running
Cypress locally and in CI.

Below we extend the previous example by adding the `container` attribute using a
[Cypress Docker Image](https://github.com/cypress-io/cypress-docker-images)
built with the version of Google Chrome embedded in the tag name of the Docker image
shown as `chrome-xxx`.
Specifying a browser version allows our tests to
execute without any influence from browser version changes in the GitHub runner
image.
Note that GitHub Actions
[requires using a Linux runner](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idcontainer) when specifying a container image.
It does not support running Docker images on Windows or macOS runners.

Below, we extend the previous example by adding the `container` attribute using a
[cypress/browsers](https://github.com/cypress-io/cypress-docker-images/tree/master/browsers)
Docker image which also includes Google Chrome.
We are using the Node.js short-form tag to select a `cypress/browsers` image
built with the corresponding Node.js version.
To specify instead an exact set of browser versions, visit the
[Docker Hub cypress/browsers](https://hub.docker.com/r/cypress/browsers) page and view the available long-form tags,
for example `cypress/browsers:node-22.15.0-chrome-136.0.7103.92-1-ff-138.0.1-edge-136.0.3240.50-1`.
Using a Cypress Docker image allows our tests to execute without any influence from
browser version changes in the GitHub runner image.

```yaml
name: Cypress Tests using Cypress Docker Image
Expand Down Expand Up @@ -417,14 +424,19 @@ aren't used in the steps.

### Specifying Browsers in Parallel Builds

If you specify a browser in parallel mode, we recommend using a
[Cypress Docker image](#Testing-with-Cypress-Docker-Images) to pin the browser
version used.
When GitHub deploys new runner image versions containing updated browser versions,
and the deployment is still in progress,
the workflow "Set up job" phase randomly uses either an old or a new runner image version.
Your test run might fail if Cypress Cloud detects differences in the browser versions between parallel jobs.

When GitHub updates the browsers in their runner images, not all runners get the
new version simultaneously. Your test run might fail if Cypress Cloud detects
differences in the runners between parallel jobs. The Docker image helps ensure
the browser is consistent during an image upgrade.
To work around this issue,
and if you specify a browser other than the default Electron browser in parallel mode,
we recommend using a
[cypress/browsers](#Testing-with-Cypress-Docker-Images) Docker image which then uses one consistent browser version.
This shields the workflow from browser version changes due to possible incomplete GitHub runner image deployments.

As mentioned in [Testing with Cypress Docker Images](#Testing-with-Cypress-Docker-Images),
this option is only available with GitHub Actions Linux runners.

## Using Cypress Cloud with GitHub Actions

Expand Down