From dd27a626e4566d11abad3f79739a75f02c4e198f Mon Sep 17 00:00:00 2001 From: Paul Jaffre Date: Mon, 24 Jul 2023 12:13:44 -0400 Subject: [PATCH] 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 * Update docs/guides/references/migration-guide.mdx Co-authored-by: Jennifer Shehane --------- Co-authored-by: Bill Glesias Co-authored-by: Jennifer Shehane --- docs/guides/references/migration-guide.mdx | 57 +++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index d696c78834..c4b7af7601 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -6,7 +6,62 @@ title: Migration Guide This guide details the changes and how to change your code to migrate to Cypress version 13.0. -[See the full changelog for version 13.0](/guides/references/changelog#13-0-0). +[See the full changelog for version 13.0](https://docs.cypress.io/guides/overview/why-cypress). + +### Cypress Cloud Test Replay + +[Test Replay](https://docs.cypress.io/guides/overview/why-cypress) is enabled by default in `v13.0` of the Cypress App. + +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). + +You can [opt out](https://docs.cypress.io/guides/overview/why-cypress) of this feature in Cloud project-level settings. + + + +### Video updates + +#### `video` is set to `false` by default + +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. + +:::cypress-config-example + +```ts +{ + video: true +} +``` + +::: + +#### `videoUploadOnPasses` configuration option has been removed + +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. + +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). + +#### `videoCompression` is set to `false` by default + +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. + +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. + +:::cypress-config-example + +```ts +{ + // value can be true/false -or- an integer between 0 and 51 + videoCompression: true, +} +``` + +::: ### `cy.readFile()` is now a query command