diff --git a/docs/api/commands/screenshot.mdx b/docs/api/commands/screenshot.mdx index ff89c232d3..f51832626e 100644 --- a/docs/api/commands/screenshot.mdx +++ b/docs/api/commands/screenshot.mdx @@ -44,19 +44,19 @@ for more. Pass in an options object to change the default behavior of `.screenshot()`. -| Option | Default | Description | -| ---------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) | -| `blackout` | `[]` | Array of string selectors used to match elements that should be blacked out when the screenshot is taken. Does not apply to `runner` captures. | -| `capture` | `'fullPage'` | Which parts of the Cypress Test Runner to capture. This value is ignored for element screenshot captures. Valid values are `viewport`, `fullPage`, or `runner`. When `viewport`, the application under test is captured in the current viewport. When `fullPage`, the application under test is captured in its entirety from top to bottom. When `runner`, the entire browser viewport, including the Cypress Command Log, is captured. For screenshots automatically taken on test failure, capture is always coerced to `runner`. When [Test Replay](TODO: add link to test replay) is enabled and the Runner UI is hidden, a `runner` screenshot will not include the Runner UI and will instead capture the application under test only in the current viewport. | -| `clip` | `null` | Position and dimensions (in pixels) used to crop the final screenshot image. Should have the following shape: `{ x: 0, y: 0, width: 100, height: 100 }` | -| `disableTimersAndAnimations` | `true` | When true, prevents JavaScript timers (`setTimeout`, `setInterval`, etc) and CSS animations from running while the screenshot is taken. | -| `padding` | `null` | Padding used to alter the dimensions of a screenshot of an element. It can either be a number, or an array of up to four numbers [using CSS shorthand notation](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties). This property is only applied for element screenshots and is ignored for all other types. | -| `scale` | `false` | Whether to scale the app to fit into the browser viewport. This is always coerced to `true` when `capture` is `runner`. | -| `timeout` | [`responseTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.screenshot()` to resolve before [timing out](#Timeouts) | -| `overwrite` | `false` | Whether to overwrite duplicate screenshot files with the same file name when saving. | -| `onBeforeScreenshot` | `null` | A callback before a non-failure screenshot is taken. When capturing screenshots of an element, the argument is the element being captured. For other screenshots, the argument is the `document`. | -| `onAfterScreenshot` | `null` | A callback after a non-failure screenshot is taken. When capturing screenshots of an element, the first argument is the element being captured. For other screenshots, the first argument is the `document`. The second argument is properties concerning the screenshot, including the `path` it was saved to and the `dimensions` of the saved screenshot. | +| Option | Default | Description | +| ---------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `log` | `true` | Displays the command in the [Command log](/guides/core-concepts/cypress-app#Command-Log) | +| `blackout` | `[]` | Array of string selectors used to match elements that should be blacked out when the screenshot is taken. Does not apply to `runner` captures. | +| `capture` | `'fullPage'` | Which parts of the Cypress Test Runner to capture. This value is ignored for element screenshot captures. Valid values are `viewport`, `fullPage`, or `runner`. When `viewport`, the application under test is captured in the current viewport. When `fullPage`, the application under test is captured in its entirety from top to bottom. When `runner`, the entire browser viewport, including the Cypress Command Log, is captured. For screenshots automatically taken on test failure, capture is always coerced to `runner`. When [Test Replay](/guides/cloud/debugging/test-replay) is enabled and the Runner UI is hidden, a `runner` screenshot will not include the Runner UI and will instead capture the application under test only in the current viewport. | +| `clip` | `null` | Position and dimensions (in pixels) used to crop the final screenshot image. Should have the following shape: `{ x: 0, y: 0, width: 100, height: 100 }` | +| `disableTimersAndAnimations` | `true` | When true, prevents JavaScript timers (`setTimeout`, `setInterval`, etc) and CSS animations from running while the screenshot is taken. | +| `padding` | `null` | Padding used to alter the dimensions of a screenshot of an element. It can either be a number, or an array of up to four numbers [using CSS shorthand notation](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties). This property is only applied for element screenshots and is ignored for all other types. | +| `scale` | `false` | Whether to scale the app to fit into the browser viewport. This is always coerced to `true` when `capture` is `runner`. | +| `timeout` | [`responseTimeout`](/guides/references/configuration#Timeouts) | Time to wait for `.screenshot()` to resolve before [timing out](#Timeouts) | +| `overwrite` | `false` | Whether to overwrite duplicate screenshot files with the same file name when saving. | +| `onBeforeScreenshot` | `null` | A callback before a non-failure screenshot is taken. When capturing screenshots of an element, the argument is the element being captured. For other screenshots, the argument is the `document`. | +| `onAfterScreenshot` | `null` | A callback after a non-failure screenshot is taken. When capturing screenshots of an element, the first argument is the element being captured. For other screenshots, the first argument is the `document`. The second argument is properties concerning the screenshot, including the `path` it was saved to and the `dimensions` of the saved screenshot. | For more details on these options and to set some as defaults across all uses of `.screenshot()`, see the diff --git a/docs/faq/questions/cloud-faq.mdx b/docs/faq/questions/cloud-faq.mdx index 81f2759a72..e71ef6de79 100644 --- a/docs/faq/questions/cloud-faq.mdx +++ b/docs/faq/questions/cloud-faq.mdx @@ -360,7 +360,7 @@ Yes! The test is captured in Cypress Cloud as it executed in your CI run. That m ### Are there performance implications when using Test Replay? -Expect an even performance exchange with Test Replay vs. video. There is more activity to capture and replay tests but without the overhead of recording, compressing, and storing video assets. `video` capture is set to `false` by default starting in Cypress `v13`. See the full [v13 changelog](/guides/references/changelog#12-0-0). +Expect an even performance exchange with Test Replay vs. video. There is more activity to capture and replay tests but without the overhead of recording, compressing, and storing video assets. `video` capture is set to `false` by default starting in Cypress `v13`. See the full [v13 changelog](/guides/references/changelog#13-0-0). ### Is every aspect of my stack included in Test Replay? diff --git a/docs/guides/cloud/debugging/test-replay.mdx b/docs/guides/cloud/debugging/test-replay.mdx index d7274dc4e1..b8fe6ff471 100644 --- a/docs/guides/cloud/debugging/test-replay.mdx +++ b/docs/guides/cloud/debugging/test-replay.mdx @@ -15,8 +15,7 @@ sidebar_position: 20 :::caution -{/* todo: change changelog url to real page when it's ready/won't break build */}
-  Test Replay is available when recording tests to Cypress Cloud using Cypress `v13` and up. See the [Cypress v13 changelog](/guides/references/changelog#12-0-0). +  Test Replay is available when recording tests to Cypress Cloud using Cypress `v13` and up. See the [Cypress v13 changelog](/guides/references/changelog#13-0-0). Test Replay currently supports Chromium-based browsers (Chrome, Edge, Electron) only. @@ -158,11 +157,7 @@ If you'd like to render the Cypress command log while recording Test Replay, you ## See also -// TODO: replace urls for v13 branch merge - -// changelog- /guides/references/changelog#13-0-0 - - [Test Replay FAQ](/faq/questions/cloud-faq#Test-Replay) -- [Cypress v13 changelog](/guides/references/changelog#12-0-0) +- [Cypress v13 changelog](/guides/references/changelog#13-0-0) - [Cypress Default Video Configuration](/guides/references/configuration#Videos) - [Cypress Video Artifacts](/guides/guides/screenshots-and-videos#Videos) diff --git a/docs/guides/guides/command-line.mdx b/docs/guides/guides/command-line.mdx index 9aab580241..bb44e0e7c5 100644 --- a/docs/guides/guides/command-line.mdx +++ b/docs/guides/guides/command-line.mdx @@ -95,33 +95,33 @@ cypress run [options] #### Options -| Option | Description | -| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--auto-cancel-after-failures` | [Overrides the Cloud project-level configuration to set the failed test threshold for auto cancellation or to disable auto cancellation when recording to the Cloud](#auto-cancel-after-runs) | -| `--browser`, `-b` | [Run Cypress in the browser with the given name. If a filesystem path is supplied, Cypress will attempt to use the browser at that path.](#cypress-run-browser-lt-browser-name-or-path-gt) | -| `--ci-build-id` | [Specify a unique identifier for a run to enable grouping or parallelization.](#cypress-run-ci-build-id-lt-id-gt) | -| `--component` | [Run component tests](/guides/core-concepts/testing-types#What-is-Component-Testing) | -| `--config`, `-c` | [Specify configuration](#cypress-run-config-lt-config-gt) | -| `--config-file`, `-C` | [Specify configuration file](#cypress-run-config-file-lt-configuration-file-gt) | -| `--e2e` | Run end to end tests (default) | -| `--env`, `-e` | [Specify environment variables](#cypress-run-env-lt-env-gt) | -| `--group` | [Group recorded tests together under a single run](#cypress-run-group-lt-name-gt) | -| `--headed` | [Displays the browser instead of running headlessly](#cypress-run-headed) | -| `--headless` | [Hide the browser instead of running headed (default during `cypress run`)](#cypress-run-headless) | -| `--help`, `-h` | Output usage information | -| `--key`, `-k` | [Specify your secret record key](#cypress-run-record-key-lt-record-key-gt) | -| `--no-exit` | [Keep Cypress open after tests in a spec file run](#cypress-run-no-exit) | -| `--no-runner-ui`, | [Hides the Cypress Runner UI](#cypress-run-no-runner-ui) | -| `--parallel` | [Run recorded specs in parallel across multiple machines](#cypress-run-parallel) | -| `--port`,`-p` | [Override default port](#cypress-run-port-lt-port-gt) | -| `--project`, `-P` | [Path to a specific project](#cypress-run-project-lt-project-path-gt) | -| `--quiet`, `-q` | If passed, Cypress output will not be printed to `stdout`. Only output from the configured [Mocha reporter](/guides/tooling/reporters) will print. | -| `--record` | [Whether to record the test run](#cypress-run-record-key-lt-record-key-gt) | -| `--reporter`, `-r` | [Specify a Mocha reporter](#cypress-run-reporter-lt-reporter-gt) | -| `--reporter-options`, `-o` | [Specify Mocha reporter options](#cypress-run-reporter-lt-reporter-gt) | -| `--runner-ui`, | [Displays the Cypress Runner UI. Useful for when [Test Replay](TODO: add test replay link) is enabled and you would still like the Cypress Runner UI to be displayed](#cypress-run-runner-ui) for screenshots and video | -| `--spec`, `-s` | [Specify the spec files to run](#cypress-run-spec-lt-spec-gt) | -| `--tag`, `-t` | [Identify a run with a tag or tags](#cypress-run-tag-lt-tag-gt) | +| Option | Description | +| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--auto-cancel-after-failures` | [Overrides the Cloud project-level configuration to set the failed test threshold for auto cancellation or to disable auto cancellation when recording to the Cloud](#auto-cancel-after-runs) | +| `--browser`, `-b` | [Run Cypress in the browser with the given name. If a filesystem path is supplied, Cypress will attempt to use the browser at that path.](#cypress-run-browser-lt-browser-name-or-path-gt) | +| `--ci-build-id` | [Specify a unique identifier for a run to enable grouping or parallelization.](#cypress-run-ci-build-id-lt-id-gt) | +| `--component` | [Run component tests](/guides/core-concepts/testing-types#What-is-Component-Testing) | +| `--config`, `-c` | [Specify configuration](#cypress-run-config-lt-config-gt) | +| `--config-file`, `-C` | [Specify configuration file](#cypress-run-config-file-lt-configuration-file-gt) | +| `--e2e` | Run end to end tests (default) | +| `--env`, `-e` | [Specify environment variables](#cypress-run-env-lt-env-gt) | +| `--group` | [Group recorded tests together under a single run](#cypress-run-group-lt-name-gt) | +| `--headed` | [Displays the browser instead of running headlessly](#cypress-run-headed) | +| `--headless` | [Hide the browser instead of running headed (default during `cypress run`)](#cypress-run-headless) | +| `--help`, `-h` | Output usage information | +| `--key`, `-k` | [Specify your secret record key](#cypress-run-record-key-lt-record-key-gt) | +| `--no-exit` | [Keep Cypress open after tests in a spec file run](#cypress-run-no-exit) | +| `--no-runner-ui`, | [Hides the Cypress Runner UI](#cypress-run-no-runner-ui) | +| `--parallel` | [Run recorded specs in parallel across multiple machines](#cypress-run-parallel) | +| `--port`,`-p` | [Override default port](#cypress-run-port-lt-port-gt) | +| `--project`, `-P` | [Path to a specific project](#cypress-run-project-lt-project-path-gt) | +| `--quiet`, `-q` | If passed, Cypress output will not be printed to `stdout`. Only output from the configured [Mocha reporter](/guides/tooling/reporters) will print. | +| `--record` | [Whether to record the test run](#cypress-run-record-key-lt-record-key-gt) | +| `--reporter`, `-r` | [Specify a Mocha reporter](#cypress-run-reporter-lt-reporter-gt) | +| `--reporter-options`, `-o` | [Specify Mocha reporter options](#cypress-run-reporter-lt-reporter-gt) | +| `--runner-ui`, | [Displays the Cypress Runner UI. Useful for when Test Replay is enabled and you would still like the Cypress Runner UI to be displayed for screenshots and video](#cypress-run-runner-ui) | +| `--spec`, `-s` | [Specify the spec files to run](#cypress-run-spec-lt-spec-gt) | +| `--tag`, `-t` | [Identify a run with a tag or tags](#cypress-run-tag-lt-tag-gt) | #### `cypress run --auto-cancel-after-failures ` {#auto-cancel-after-runs} @@ -402,7 +402,7 @@ To force Cypress to render the Runner UI, use `--runner-ui`. cypress run --runner-ui ``` -Useful for when [Test Replay](TODO: add link to test replay) is enabled and you would still like the Runner UI to be rendered for screenshots and video. +Useful for when [Test Replay](/guides/cloud/debugging/test-replay) is enabled and you would still like the Runner UI to be rendered for screenshots and video. #### `cypress run --spec ` {#cypress-run-spec-lt-spec-gt} diff --git a/docs/guides/guides/module-api.mdx b/docs/guides/guides/module-api.mdx index e888bc4eb3..cece9d29f8 100644 --- a/docs/guides/guides/module-api.mdx +++ b/docs/guides/guides/module-api.mdx @@ -56,31 +56,31 @@ node e2e-run-tests.js Just like the [Command Line options](/guides/guides/command-line) for `cypress run`, you can pass options that modify how Cypress runs. -| Option | Type | Description | -| ------------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `autoCancelAfterFailures` | _number_ | _false_ | Specify the number of failures to cancel a run being recorded to the Cloud or false to disable auto-cancellation. | -| `browser` | _string_ | Specify different browser to run tests in, either by name or by filesystem path | -| `ciBuildId` | _string_ | Specify a unique identifier for a run to enable [grouping](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs) or [parallelization](/guides/cloud/smart-orchestration/parallelization) | -| `config` | _object_ | Specify [configuration](/guides/references/configuration) | -| `configFile` | _string_ | Path to the [configuration file](/guides/references/configuration#Configuration-file) to be used. | -| `env` | _object_ | Specify [environment variables](/guides/guides/environment-variables) | -| `group` | _string_ | [Group](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs) recorded tests together under a single run | -| `headed` | _boolean_ | Displays the browser instead of running headlessly | -| `headless` | _boolean_ | Hide the browser instead of running headed (default during `cypress run`) | -| `key` | _string_ | Specify your secret record key | -| `exit` | _boolean_ | Whether to close Cypress after all tests run | -| `parallel` | _boolean_ | Run recorded specs in [parallel](/guides/cloud/smart-orchestration/parallelization) across multiple machines | -| `port` | _number_ | Override default port | -| `project` | _string_ | Path to a specific project | -| `quiet` | _boolean_ | If passed, Cypress output will not be printed to `stdout`. Only output from the configured [Mocha reporter](/guides/tooling/reporters) will print. | -| `record` | _boolean_ | Whether to record the test run | -| `reporter` | _string_ | Specify a [Mocha reporter](/guides/tooling/reporters) | -| `reporterOptions` | _object_ | Specify [Mocha reporter](/guides/tooling/reporters) options | -| `runnerUi` | _boolean_ | Whether to display the Cypress Runner UI. Defaults to `true` when [Test Replay](TODO: add test replay link) is not enabled. Defaults to `false` when [Test Replay](TODO: add test replay link) is enabled. | -| `slowTestThreshold` | _number_ | Time, in milliseconds, to consider a test "slow" during `cypress run`. A slow test will display in orange text in the default reporter. | -| `spec` | _string_ | Specify the specs to run, see examples below | -| `tag` | _string_ | Identify a run with a tag or tags | -| `testingType` | _string_ | Specify the type of tests to execute; either `e2e` or `component`. Defaults to `e2e` | +| Option | Type | Description | +| ------------------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `autoCancelAfterFailures` | _number_ | _false_ | Specify the number of failures to cancel a run being recorded to the Cloud or false to disable auto-cancellation. | +| `browser` | _string_ | Specify different browser to run tests in, either by name or by filesystem path | +| `ciBuildId` | _string_ | Specify a unique identifier for a run to enable [grouping](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs) or [parallelization](/guides/cloud/smart-orchestration/parallelization) | +| `config` | _object_ | Specify [configuration](/guides/references/configuration) | +| `configFile` | _string_ | Path to the [configuration file](/guides/references/configuration#Configuration-file) to be used. | +| `env` | _object_ | Specify [environment variables](/guides/guides/environment-variables) | +| `group` | _string_ | [Group](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs) recorded tests together under a single run | +| `headed` | _boolean_ | Displays the browser instead of running headlessly | +| `headless` | _boolean_ | Hide the browser instead of running headed (default during `cypress run`) | +| `key` | _string_ | Specify your secret record key | +| `exit` | _boolean_ | Whether to close Cypress after all tests run | +| `parallel` | _boolean_ | Run recorded specs in [parallel](/guides/cloud/smart-orchestration/parallelization) across multiple machines | +| `port` | _number_ | Override default port | +| `project` | _string_ | Path to a specific project | +| `quiet` | _boolean_ | If passed, Cypress output will not be printed to `stdout`. Only output from the configured [Mocha reporter](/guides/tooling/reporters) will print. | +| `record` | _boolean_ | Whether to record the test run | +| `reporter` | _string_ | Specify a [Mocha reporter](/guides/tooling/reporters) | +| `reporterOptions` | _object_ | Specify [Mocha reporter](/guides/tooling/reporters) options | +| `runnerUi` | _boolean_ | Whether to display the Cypress Runner UI. Defaults to `true` when [Test Replay](/guides/cloud/debugging/test-replay) is not enabled. Defaults to `false` when [Test Replay](/guides/cloud/debugging/test-replay) is enabled. | +| `slowTestThreshold` | _number_ | Time, in milliseconds, to consider a test "slow" during `cypress run`. A slow test will display in orange text in the default reporter. | +| `spec` | _string_ | Specify the specs to run, see examples below | +| `tag` | _string_ | Identify a run with a tag or tags | +| `testingType` | _string_ | Specify the type of tests to execute; either `e2e` or `component`. Defaults to `e2e` | ### Examples diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index 3085bf4a94..52d64f7903 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -6,31 +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](https://docs.cypress.io/guides/overview/why-cypress). +[See the full changelog for version v13.0](/guides/references/changelog#13-0-0). ### 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. +[Test Replay](/guides/cloud/debugging/test-replay) 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). With Test Replay enabled, the Cypress Runner UI is hidden by default when recording a run to the Cloud. If the Runner UI is needed during the run, you can enable it by passing [`--runner-ui`](/guides/guides/command-line#cypress-run-runner-ui) to the [`cypress run`](/guides/guides/command-line#cypress-run) command. -You can [opt out](https://docs.cypress.io/guides/overview/why-cypress) of this feature in Cloud project-level settings. - - +You can [opt out](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) 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. +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](/guides/cloud/debugging/test-replay) is not available. :::cypress-config-example