Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 60 additions & 1 deletion docs/guides/references/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,66 @@ 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.

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

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

Expand Down