You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/references/migration-guide.mdx
+43Lines changed: 43 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,49 @@ This guide details the changes and how to change your code to migrate to Cypress
8
8
version 13.0.
9
9
[See the full changelog for version 13.0](/guides/references/changelog#13-0-0).
10
10
11
+
### Video updates
12
+
13
+
#### <Iconname="exclamation-triangle"color="red" /> Breaking Change: `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
+
#### <Iconname="exclamation-triangle"color="red" /> Breaking Change: `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
+
11
54
### `cy.readFile()` is now a query command
12
55
13
56
In Cypress 13, the [`.readFile()`](/api/commands/readFile) command is now a query.
0 commit comments