Skip to content

Commit 214bcf2

Browse files
Merge branch 'main' into release/15.0.0
2 parents 62f2a96 + aac4097 commit 214bcf2

File tree

7 files changed

+50
-38
lines changed

7 files changed

+50
-38
lines changed

docs/app/continuous-integration/circleci.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ A typical project can have:
4040
```yaml title=".circleci/config.yml"
4141
version: 2.1
4242
orbs:
43-
# "cypress-io/cypress@3" installs the latest published
43+
# "cypress-io/cypress@4" installs the latest published
4444
# version "s.x.y" of the orb. We recommend you then use
45-
# the strict explicit version "cypress-io/cypress@3.x.y"
45+
# the strict explicit version "cypress-io/cypress@4.x.y"
4646
# to lock the version and prevent unexpected CI changes
47-
cypress: cypress-io/cypress@3
47+
cypress: cypress-io/cypress@4
4848
workflows:
4949
build:
5050
jobs:
@@ -64,7 +64,7 @@ run tests across 4 CI machines
6464
```yaml title=".circleci/config.yml"
6565
version: 2.1
6666
orbs:
67-
cypress: cypress-io/cypress@3
67+
cypress: cypress-io/cypress@4
6868
workflows:
6969
build:
7070
jobs:
@@ -101,7 +101,7 @@ Check out the full <Icon name="github" inline="true" callout="RWA Circle CI conf
101101
```yaml title=".circleci/config.yml"
102102
version: 2.1
103103
orbs:
104-
cypress: cypress-io/cypress@3
104+
cypress: cypress-io/cypress@4
105105
workflows:
106106
test:
107107
jobs:
@@ -114,7 +114,7 @@ workflows:
114114
```yaml title=".circleci/config.yml"
115115
version: 2.1
116116
orbs:
117-
cypress: cypress-io/cypress@3
117+
cypress: cypress-io/cypress@4
118118
workflows:
119119
test:
120120
jobs:
@@ -132,7 +132,7 @@ you are passing the `--browser` flag in your `cypress-command`
132132
```yaml title=".circleci/config.yml"
133133
version: 2.1
134134
orbs:
135-
cypress: cypress-io/cypress@3
135+
cypress: cypress-io/cypress@4
136136
workflows:
137137
test:
138138
jobs:

docs/app/continuous-integration/github-actions.mdx

+31-20
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,11 @@ in the [GitHub Action Documentation](https://docs.github.com/en/actions).
2929
## GitHub Actions + Cypress Screencasts
3030

3131
1. [What is Continuous Integration?](https://youtu.be/USX6AntcPyg)
32-
2. [Actions & Workflows](https://youtu.be/N0TOFWy1Xvg)
33-
3. [Example App Overview](https://youtu.be/zGrAhZkCoUE)
34-
4. [Understanding how to configure a workflow](https://youtu.be/vVr7DXDdUks)
35-
5. [Running Tests in GitHub Actions CI/CD Workflow](https://youtu.be/23ZGSrmbV_4)
36-
6. [Debugging Test Failures in CI](https://youtu.be/Oqq-_QZWzhg)
37-
7. [Running Tests in Parallel](https://youtu.be/96Yn_IiQUJI)
32+
1. [Actions & Workflows](https://youtu.be/N0TOFWy1Xvg)
33+
1. [Understanding how to configure a workflow](https://youtu.be/vVr7DXDdUks)
34+
1. [Running Tests in GitHub Actions CI/CD Workflow](https://youtu.be/23ZGSrmbV_4)
35+
1. [Debugging Test Failures in CI](https://youtu.be/Oqq-_QZWzhg)
36+
1. [Running Tests in Parallel](https://youtu.be/96Yn_IiQUJI)
3837

3938
:::
4039

@@ -171,13 +170,20 @@ Cypress offers various
171170
[Docker Images](https://github.com/cypress-io/cypress-docker-images) for running
172171
Cypress locally and in CI.
173172

174-
Below we extend the previous example by adding the `container` attribute using a
175-
[Cypress Docker Image](https://github.com/cypress-io/cypress-docker-images)
176-
built with the version of Google Chrome embedded in the tag name of the Docker image
177-
shown as `chrome-xxx`.
178-
Specifying a browser version allows our tests to
179-
execute without any influence from browser version changes in the GitHub runner
180-
image.
173+
Note that GitHub Actions
174+
[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.
175+
It does not support running Docker images on Windows or macOS runners.
176+
177+
Below, we extend the previous example by adding the `container` attribute using a
178+
[cypress/browsers](https://github.com/cypress-io/cypress-docker-images/tree/master/browsers)
179+
Docker image which also includes Google Chrome.
180+
We are using the Node.js short-form tag to select a `cypress/browsers` image
181+
built with the corresponding Node.js version.
182+
To specify instead an exact set of browser versions, visit the
183+
[Docker Hub cypress/browsers](https://hub.docker.com/r/cypress/browsers) page and view the available long-form tags,
184+
for example `cypress/browsers:node-22.15.0-chrome-136.0.7103.92-1-ff-138.0.1-edge-136.0.3240.50-1`.
185+
Using a Cypress Docker image allows our tests to execute without any influence from
186+
browser version changes in the GitHub runner image.
181187

182188
```yaml
183189
name: Cypress Tests using Cypress Docker Image
@@ -417,14 +423,19 @@ aren't used in the steps.
417423

418424
### Specifying Browsers in Parallel Builds
419425

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

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

429440
## Using Cypress Cloud with GitHub Actions
430441

docs/app/continuous-integration/overview.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -431,8 +431,7 @@ If you see a message about a missing dependency when you run Cypress in a Linux
431431

432432
### Caching
433433

434-
As of [Cypress version 3.0](/app/references/changelog#3-0-0), Cypress
435-
downloads its binary to the global system cache - on linux that is
434+
Cypress downloads its binary to the global system cache - on Linux that is
436435
`~/.cache/Cypress`. By ensuring this cache persists across builds you can save
437436
minutes off install time by preventing a large binary download.
438437

docs/app/get-started/install-cypress.mdx

+4-2
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,10 @@ need prebuilt.
104104
Cypress supports running under these operating systems:
105105

106106
- **macOS** 11 and above _(Intel or Apple Silicon 64-bit (x64 or arm64))_
107-
- **Linux** Ubuntu 20.04 and above, Fedora 40 and above, and Debian 11 and above _(x64 or arm64)_
108-
(see [Linux Prerequisites](#Linux-Prerequisites) down below)
107+
- **Linux** _(x64 or arm64)_ see also [Linux Prerequisites](#Linux-Prerequisites) down below
108+
- Ubuntu 20.04 and above
109+
- Debian 11 and above
110+
- Fedora 41 and above
109111
- **Windows** 10 and above _(x64)_
110112
- **Windows Server** 2019, 2022 and 2025 _(x64)_
111113

docs/app/guides/cross-browser-testing.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The following example demonstrates a nightly CI schedule against production
102102
```yaml title='.circleci/config.yml'
103103
version: 2.1
104104
orbs:
105-
cypress: cypress-io/cypress@3
105+
cypress: cypress-io/cypress@4
106106
workflows:
107107
nightly:
108108
triggers:
@@ -132,7 +132,7 @@ Firefox issues can be caught before a production release:
132132
```yaml title='.circleci/config.yml'
133133
version: 2.1
134134
orbs:
135-
cypress: cypress-io/cypress@3
135+
cypress: cypress-io/cypress@4
136136
workflows:
137137
test_develop:
138138
jobs:
@@ -174,7 +174,7 @@ Circle CI workflow UI to distinguish the jobs.
174174
```yaml title='.circleci/config.yml'
175175
version: 2.1
176176
orbs:
177-
cypress: cypress-io/cypress@3
177+
cypress: cypress-io/cypress@4
178178
workflows:
179179
build:
180180
jobs:
@@ -211,7 +211,7 @@ named `firefox`.
211211
```yaml title='.circleci/config.yml'
212212
version: 2.1
213213
orbs:
214-
cypress: cypress-io/cypress@3
214+
cypress: cypress-io/cypress@4
215215
workflows:
216216
build:
217217
jobs:

docs/app/references/advanced-installation.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ DEBUG=cypress:cli* pnpm cypress install
147147

148148
## Binary cache
149149

150-
As of version `3.0`, Cypress downloads the matching Cypress binary to the global
150+
Cypress downloads the matching Cypress binary to the global
151151
system cache, so that the binary can be shared between projects. By default,
152152
global cache folders are:
153153

docs/app/references/changelog.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ _Released 5/6/2025_
2323
**Bugfixes:**
2424

2525
- Fixed an issue where the configuration setting `trashAssetsBeforeRuns=false` was ignored for assets in the `videosFolder`. These assets were incorrectly deleted before running tests with `cypress run`. Addresses [#8280](https://github.com/cypress-io/cypress/issues/8280).
26-
- Fixed a potential hang condition when `@cypress/grep` would match many files and `stdout`/`stderr` was piped to a file. Fixes [#31625](https://github.com/cypress-io/cypress/issues/31625). Addressed in [31631](https://github.com/cypress-io/cypress/pull/31631).
26+
- Fixed a potential hang condition when `@cypress/grep` would match many files and `stdout`/`stderr` was piped to a file. Fixes [#31625](https://github.com/cypress-io/cypress/issues/31625). Addressed in [#31631](https://github.com/cypress-io/cypress/pull/31631).
2727
- Fixed a potential hang condition when navigating to `about:blank`. Addressed in [#31634](https://github.com/cypress-io/cypress/pull/31634).
2828

2929
**Misc:**
@@ -33,7 +33,7 @@ _Released 5/6/2025_
3333

3434
**Dependency Updates:**
3535

36-
- Downgraded `cli-table3` to 0.6.1. Addressed in [31631](https://github.com/cypress-io/cypress/pull/31631).
36+
- Downgraded `cli-table3` to 0.6.1. Addressed in [#31631](https://github.com/cypress-io/cypress/pull/31631).
3737

3838
## 14.3.2
3939

0 commit comments

Comments
 (0)