Skip to content

Commit dd27a62

Browse files
jaffrepaulAtofStrykerjennifer-shehane
authored
docs: v13 video and TR migration info (#5383)
* added video config migration info * added tr migration info * PR feedback * PR feedback * PR feedback * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * Update docs/guides/references/migration-guide.mdx Co-authored-by: Jennifer Shehane <jennifer@cypress.io> --------- Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
1 parent a0fcdf8 commit dd27a62

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

docs/guides/references/migration-guide.mdx

+56-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,62 @@ title: Migration Guide
66

77
This guide details the changes and how to change your code to migrate to Cypress
88
version 13.0.
9-
[See the full changelog for version 13.0](/guides/references/changelog#13-0-0).
9+
[See the full changelog for version 13.0](https://docs.cypress.io/guides/overview/why-cypress).
10+
11+
### Cypress Cloud Test Replay
12+
13+
[Test Replay](https://docs.cypress.io/guides/overview/why-cypress) is enabled by default in `v13.0` of the Cypress App.
14+
15+
You may need to allowlist `capture.cypress.io` if you work with a strict VPN. See our FAQ section about [VPN subdomain allowlisting](/faq/questions/cloud-faq#Im-working-with-a-restrictive-VPN-Which-subdomains-do-I-have-to-allow-on-my-VPN-for-Cypress-Cloud-to-work-properly).
16+
17+
You can [opt out](https://docs.cypress.io/guides/overview/why-cypress) of this feature in Cloud project-level settings.
18+
19+
<!---
20+
TODO: replace urls for merge to v13 branch:
21+
22+
changelog- /guides/references/changelog#13-0-0
23+
test replay- /guides/cloud/debugging/test-replay
24+
opt out- /guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay
25+
--->
26+
27+
### Video updates
28+
29+
#### `video` is set to `false` by default
30+
31+
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.
32+
33+
:::cypress-config-example
34+
35+
```ts
36+
{
37+
video: true
38+
}
39+
```
40+
41+
:::
42+
43+
#### `videoUploadOnPasses` configuration option has been removed
44+
45+
Most users used `videoUploadOnPasses` as a way to skip the time to compress and upload videos to the Cloud. Since we're turning off `videoCompression` by default, this configuration option does not offer the time saving value that it once would.
46+
47+
If you want to prevent a passing test from uploading to the Cloud, we recommend deleting the video using our [guide with code examples to discard captured video of passing tests](/guides/guides/screenshots-and-videos#Control-which-videos-to-keep-and-upload-to-Cypress-Cloud).
48+
49+
#### `videoCompression` is set to `false` by default
50+
51+
Cypress has the capability to compress recorded videos after a run to reduce the video file size. By default, compression is now turned off. This results in a reduced run time by removing the time to compress the video, a larger video file size and better video quality.
52+
53+
You can enable this with the `videoCompression` [configuration](/guides/references/configuration#Videos) option if you'd like to reduce the video file size for any reason. This will also reduce the video quality and take slightly longer to process and complete the run.
54+
55+
:::cypress-config-example
56+
57+
```ts
58+
{
59+
// value can be true/false -or- an integer between 0 and 51
60+
videoCompression: true,
61+
}
62+
```
63+
64+
:::
1065

1166
### `cy.readFile()` is now a query command
1267

0 commit comments

Comments
 (0)