From 5576663e2a0a15f2265405c04c036eb9af685cf2 Mon Sep 17 00:00:00 2001 From: paulj Date: Wed, 19 Jul 2023 16:51:51 -0400 Subject: [PATCH 1/7] added video config migration info --- docs/guides/references/migration-guide.mdx | 43 ++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index d696c78834..37c4d4de0f 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -8,6 +8,49 @@ 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). +### Video updates + +#### `video` is set to false by default + +Whether Cypress will capture a video of the tests run with `cypress run`. + +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 + +Whether Cypress will process, compress, and upload videos to Cypress Cloud even when all tests in a spec file are passing. + +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. + +#### `videoCompression` is set to false by default + +The quality setting for the video compression. + +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. + +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. + +:::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 In Cypress 13, the [`.readFile()`](/api/commands/readFile) command is now a query. From 5413bb34a44b2451dce05181ecfa564992f47f08 Mon Sep 17 00:00:00 2001 From: Paul Jaffre Date: Fri, 30 Jun 2023 13:05:47 -0400 Subject: [PATCH 2/7] added tr migration info --- docs/guides/references/migration-guide.mdx | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index 37c4d4de0f..d63df5645c 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -6,7 +6,23 @@ 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 whitelist `capture.cypress.io` if you work with a strict VPN. See our FAQ section about [VPN subdomain whitelisting](/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 From a86417548ec39545e296d8b4adfb437029164c45 Mon Sep 17 00:00:00 2001 From: paulj Date: Thu, 20 Jul 2023 15:06:34 -0400 Subject: [PATCH 3/7] PR feedback --- docs/guides/references/migration-guide.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index d63df5645c..bfee69466b 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -46,7 +46,9 @@ You can continue recording video, by passing `video: true`, if you want video lo Whether Cypress will process, compress, and upload videos to Cypress Cloud even when all tests in a spec file are passing. -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. +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 @@ -54,7 +56,7 @@ The quality setting for the video compression. 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. -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. +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 From 2cc3861ab691f52cd0e2983f3e2482479a7061fc Mon Sep 17 00:00:00 2001 From: paulj Date: Thu, 20 Jul 2023 15:08:51 -0400 Subject: [PATCH 4/7] PR feedback --- docs/guides/references/migration-guide.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index bfee69466b..2f03fcb4b2 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -12,7 +12,7 @@ version 13.0. [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 whitelist `capture.cypress.io` if you work with a strict VPN. See our FAQ section about [VPN subdomain whitelisting](/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 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. From 1ac1899cae110cd2f85679280ff6abc08a0fff3d Mon Sep 17 00:00:00 2001 From: paulj Date: Thu, 20 Jul 2023 15:10:51 -0400 Subject: [PATCH 5/7] PR feedback --- docs/guides/references/migration-guide.mdx | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index 2f03fcb4b2..04fd171cbc 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -28,8 +28,6 @@ opt out- /guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay #### `video` is set to false by default -Whether Cypress will capture a video of the tests run with `cypress run`. - 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 @@ -44,16 +42,12 @@ You can continue recording video, by passing `video: true`, if you want video lo #### `videoUploadOnPasses` configuration option has been removed -Whether Cypress will process, compress, and upload videos to Cypress Cloud even when all tests in a spec file are passing. - 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 -The quality setting for the video compression. - 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. 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. From 9dd2983ce4af0bed67877a9924665c7ffe750cc7 Mon Sep 17 00:00:00 2001 From: Paul Jaffre Date: Fri, 21 Jul 2023 10:16:51 -0400 Subject: [PATCH 6/7] Apply suggestions from code review Co-authored-by: Bill Glesias --- docs/guides/references/migration-guide.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index 04fd171cbc..ecd62d5cf8 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -17,7 +17,7 @@ You may need to allowlist `capture.cypress.io` if you work with a strict VPN. Se You can [opt out](https://docs.cypress.io/guides/overview/why-cypress) of this feature in Cloud project-level settings.