Skip to content

Commit

Permalink
docs: v13 video and TR migration info (#5383)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
3 people committed Jul 24, 2023
1 parent a0fcdf8 commit dd27a62
Showing 1 changed file with 56 additions and 1 deletion.
57 changes: 56 additions & 1 deletion docs/guides/references/migration-guide.mdx
Expand Up @@ -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.

<!---
TODO: replace urls for merge to v13 branch:

changelog- /guides/references/changelog#13-0-0
test replay- /guides/cloud/debugging/test-replay
opt out- /guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay
--->

### 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

Expand Down

0 comments on commit dd27a62

Please sign in to comment.