Skip to content

Commit 5576663

Browse files
committed
added video config migration info
1 parent a0fcdf8 commit 5576663

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/guides/references/migration-guide.mdx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,49 @@ This guide details the changes and how to change your code to migrate to Cypress
88
version 13.0.
99
[See the full changelog for version 13.0](/guides/references/changelog#13-0-0).
1010

11+
### Video updates
12+
13+
#### `video` is set to false by default
14+
15+
Whether Cypress will capture a video of the tests run with `cypress run`.
16+
17+
You can continue recording video, by passing `video: true`, if you want video locally or you want video for some other reason, like in non-Chromium browsers where [Test Replay](https://docs.cypress.io/guides/overview/why-cypress) is not available.
18+
19+
:::cypress-config-example
20+
21+
```ts
22+
{
23+
video: true
24+
}
25+
```
26+
27+
:::
28+
29+
#### `videoUploadOnPasses` configuration option has been removed
30+
31+
Whether Cypress will process, compress, and upload videos to Cypress Cloud even when all tests in a spec file are passing.
32+
33+
See our [Control which videos to keep and upload to Cypress Cloud](/guides/guides/screenshots-and-videos#Control-which-videos-to-keep-and-upload-to-Cypress-Cloud) guide with code examples to discard captured video of passing tests.
34+
35+
#### `videoCompression` is set to false by default
36+
37+
The quality setting for the video compression.
38+
39+
Cypress has the capability to compress recorded videos after a run to reduce the video file size. By default, compression is turned off, which results in a larger file size and better video quality.
40+
41+
You can enable this with the `videoCompression` [configuration](/guides/references/configuration#Videos) option to reduce the file size. This will also reduce the video quality and take slightly longer to process and complete the run.
42+
43+
:::cypress-config-example
44+
45+
```ts
46+
{
47+
// value can be true/false -or- an integer between 0 and 51
48+
videoCompression: true,
49+
}
50+
```
51+
52+
:::
53+
1154
### `cy.readFile()` is now a query command
1255

1356
In Cypress 13, the [`.readFile()`](/api/commands/readFile) command is now a query.

0 commit comments

Comments
 (0)