diff --git a/docs/api/commands/screenshot.mdx b/docs/api/commands/screenshot.mdx index f51832626e5..ee9d39a16ea 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](/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. | +| 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/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 @@ -360,6 +360,6 @@ following: - [`cy.debug()`](/api/commands/debug) - [`.pause()`](/api/commands/pause) - [Cypress Cloud](/guides/cloud/introduction) -- [Test Replay](/guides/cloud/debugging/test-replay) +- [Test Replay](/guides/cloud/test-replay) - [Screenshots and Videos](/guides/guides/screenshots-and-videos) - [Visual Testing](/guides/tooling/visual-testing) diff --git a/docs/api/cypress-api/screenshot-api.mdx b/docs/api/cypress-api/screenshot-api.mdx index 0436e01e10e..05c6dc0d678 100644 --- a/docs/api/cypress-api/screenshot-api.mdx +++ b/docs/api/cypress-api/screenshot-api.mdx @@ -27,16 +27,16 @@ Cypress.Screenshot.defaults(options) An object containing one or more of the following: -| Option | Default | Description | -| ---------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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`, your application under test is captured in the current viewport. When `fullPage`, your 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. | -| `disableTimersAndAnimations` | `true` | When true, prevents JavaScript timers (`setTimeout`, `setInterval`, etc) and CSS animations from running while the screenshot is taken. | -| `scale` | `false` | Whether to scale the app to fit into the browser viewport. This is always coerced to `true` for `runner` captures. | -| `screenshotOnRunFailure` | `true` | When true, automatically takes a screenshot when there is a failure during `cypress run`. | -| `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. For an element capture, the argument is the element being captured. For other screenshots, the argument is the `$el`. | -| `onAfterScreenshot` | `null` | A callback after a (non-failure) screenshot is taken. For an element capture, the first argument is the element being captured. For other screenshots, the first argument is the `$el`. 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 | +| ---------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`, your application under test is captured in the current viewport. When `fullPage`, your 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/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. | +| `disableTimersAndAnimations` | `true` | When true, prevents JavaScript timers (`setTimeout`, `setInterval`, etc) and CSS animations from running while the screenshot is taken. | +| `scale` | `false` | Whether to scale the app to fit into the browser viewport. This is always coerced to `true` for `runner` captures. | +| `screenshotOnRunFailure` | `true` | When true, automatically takes a screenshot when there is a failure during `cypress run`. | +| `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. For an element capture, the argument is the element being captured. For other screenshots, the argument is the `$el`. | +| `onAfterScreenshot` | `null` | A callback after a (non-failure) screenshot is taken. For an element capture, the first argument is the element being captured. For other screenshots, the first argument is the `$el`. The second argument is properties concerning the screenshot, including the path it was saved to and the dimensions of the saved screenshot. | ## Examples diff --git a/docs/faq/questions/cloud-faq.mdx b/docs/faq/questions/cloud-faq.mdx index 04a356f716b..d84fd05f69d 100644 --- a/docs/faq/questions/cloud-faq.mdx +++ b/docs/faq/questions/cloud-faq.mdx @@ -46,7 +46,7 @@ before being sent to the Cloud so those are not captured. When [Test Replay](#Test-Replay) capturing is enabled, the additional data outlined below will be sent to the Cloud. You can -[disable capturing](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) this data. +[disable capturing](/guides/cloud/test-replay#Opt-out-of-Test-Replay) this data. - The rendered DOM and CSS styles for the application under test - Cypress commands and events represented in the Command Log @@ -87,7 +87,7 @@ the number of tests you record each month in your organization. Tests are recorded when [cypress run](/guides/guides/command-line#cypress-run) is called with the `--record` flag while supplying the record `--key`. This -means your [test run data](/guides/cloud/debugging/recorded-runs#Latest-Runs) is being +means your [test run data](/guides/cloud/recorded-runs#Latest-Runs) is being "recorded" to Cypress Cloud. We consider each time the `it()` function is called to be a single test. So you @@ -164,7 +164,7 @@ any test results. ### What is the projectId for? The `projectId` is a 6-character string that helps identify your project once -you've [set up your tests to record](/guides/cloud/debugging/recorded-runs#Latest-Runs). +you've [set up your tests to record](/guides/cloud/recorded-runs#Latest-Runs). It's generated by Cypress and typically is found in your [Cypress configuration](/guides/references/configuration). @@ -185,7 +185,7 @@ section of the [Cypress Cloud](/guides/cloud/introduction) docs. ### What is a Record Key? A _Record Key_ is a GUID that's generated automatically by Cypress once you've -[set up your tests to record](/guides/cloud/debugging/recorded-runs#Latest-Runs). It helps +[set up your tests to record](/guides/cloud/recorded-runs#Latest-Runs). It helps identify your project and authenticate that your project is even _allowed_ to record tests. @@ -204,14 +204,14 @@ section of the [Cypress Cloud](/guides/cloud/introduction) docs. ### How do I record my tests? 1. First [set up the project to record](/guides/cloud/getting-started#Setup). -2. Then [record your runs](/guides/cloud/debugging/recorded-runs#Latest-Runs). +2. Then [record your runs](/guides/cloud/recorded-runs#Latest-Runs). After recording your tests, you will see them in [Cypress Cloud](https://on.cypress.io/cloud) and in the Cypress App [Runs](/guides/core-concepts/cypress-app#Runs) tab. ### Can I delete a run from Cypress Cloud? -You can [archive a run](/guides/cloud/debugging/recorded-runs#Archive-run) so that it does +You can [archive a run](/guides/cloud/recorded-runs#Archive-run) so that it does not display in the runs list or in analytics. **Note:** Archiving the recorded runs has no effect on the amount of tests @@ -330,7 +330,7 @@ in your account will be permanently deleted. ### What is Test Replay? -[Test Replay](/guides/cloud/debugging/test-replay) enables you and your team to troubleshoot and debug failed tests faster. After updating to Cypress `v13`, the new feature will automatically record all browser events and allow you to “replay” what your application under test looked like. +[Test Replay](/guides/cloud/test-replay) enables you and your team to troubleshoot and debug failed tests faster. After updating to Cypress `v13`, the new feature will automatically record all browser events and allow you to “replay” what your application under test looked like. Wind back the clock to any point in an application's test execution and directly interact with tests as they happened in CI. Debug complex problems as if you were there when they first happened. You can: @@ -381,7 +381,7 @@ Our aim is to create an impactful debugging experience that covers the most grou Test Replay leverages [Chrome DevTools Protocol(CDP)](https://chromedevtools.github.io/devtools-protocol/), so currently supports Chromium-based browsers (Chrome, Edge, and Electron) only. -Test Replay would be disabled, with a message that it's only available on Chromium, for tests run in Firefox or WebKit (Safari). You can still record and capture test [artifacts](/guides/cloud/debugging/recorded-runs#Artifacts) (screenshots, videos and CI logs) via other browsers in separate [run groups](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs). +Test Replay would be disabled, with a message that it's only available on Chromium, for tests run in Firefox or WebKit (Safari). You can still record and capture test [artifacts](/guides/cloud/recorded-runs#Artifacts) (screenshots, videos and CI logs) via other browsers in separate [run groups](/guides/cloud/smart-orchestration/parallelization#Grouping-test-runs). ### Can I replay tests from historical Cypress Cloud runs? @@ -389,7 +389,7 @@ Test Replay is available for tests recorded using Cypress `v13` and up. Tests re ### Can I enable or disable Test Replay for specific, individual tests, or is it a global setting? Can I configure my settings so that Test Replay is only enabled for failing test retries? -At this time, users can only opt-out of Test Replay via [project-level settings](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) in Cypress Cloud. There is no local option for opting out at this time. +At this time, users can only opt-out of Test Replay via [project-level settings](/guides/cloud/test-replay#Opt-out-of-Test-Replay) in Cypress Cloud. There is no local option for opting out at this time. ### Can I share my test replays? diff --git a/docs/guides/cloud/branch-review.mdx b/docs/guides/cloud/branch-review.mdx index 758012f0d64..2b9aaad91f4 100644 --- a/docs/guides/cloud/branch-review.mdx +++ b/docs/guides/cloud/branch-review.mdx @@ -98,7 +98,7 @@ The header includes the Git commit message, PR selector, PR status, and base and If there are multiple pull requests open for the same branch, you can select the pull request you want to review from the dropdown to the right of the commit message. -Clicking the branch label will link you directly to the appropriate [run overview](/guides/cloud/debugging/recorded-runs#Overview-tab) and hovering on these elements exposes additional run meta data. +Clicking the branch label will link you directly to the appropriate [run overview](/guides/cloud/recorded-runs#Overview-tab) and hovering on these elements exposes additional run meta data. Test Replay](/guides/cloud/debugging/test-replay). +Replay the test as it executed during the recorded run with full debug capability using [ Test Replay](/guides/cloud/test-replay). Or view each test's -[command logs, screenshots, video replays, stack traces, and CI logs](/guides/cloud/debugging/recorded-runs#Test-detail-sidebar). +[command logs, screenshots, video replays, stack traces, and CI logs](/guides/cloud/recorded-runs#Test-detail-sidebar). Quickly identifying a test failure in CI is just a click away. ### Analyze and diagnose test health -View each [run's overview](/guides/cloud/debugging/recorded-runs#Overview-tab) to see and compare +View each [run's overview](/guides/cloud/recorded-runs#Overview-tab) to see and compare past runs and analyze trends over time. You can quickly analyze changes in your setup that might introduce problematic trends as well as identify unreliable tests with [Flaky Test Management](/guides/cloud/flaky-test-management). @@ -64,7 +64,7 @@ no setup required! You can prioritize recently failed specs with surface problems earlier, and cancel whole test runs on failure with [Auto Cancellation](/guides/cloud/smart-orchestration/run-cancellation) to save on resource usage. You can also -[cancel in-progress runs](/guides/cloud/debugging/recorded-runs#Run-cancellation) manually +[cancel in-progress runs](/guides/cloud/recorded-runs#Run-cancellation) manually from Cypress Cloud if you need to. -2. Or navigate to the [test detail sidebar](/guides/cloud/debugging/recorded-runs#Test-detail-sidebar) header or above each attempt in the errors panel. The header option will replay the first failing test while the option above each attempt will replay the affiliated test. +2. Or navigate to the [test detail sidebar](/guides/cloud/recorded-runs#Test-detail-sidebar) header or above each attempt in the errors panel. The header option will replay the first failing test while the option above each attempt will replay the affiliated test. This screen shows detailed information about the most recently recorded -[test runs](/guides/cloud/debugging/recorded-runs#Latest-Runs) to Cypress Cloud, showing +[test runs](/guides/cloud/recorded-runs#Latest-Runs) to Cypress Cloud, showing the latest first. Cypress uses Git to show runs for your branch. Ensure that version control is @@ -192,11 +192,11 @@ This feature eliminates the tedious process of switching between Cypress, your local editor, and CI output, in order to fix failed tests. It does this by enabling you to use the [Test Runner](#Test-Runner) to run only the tests that failed in your last recorded test run, as well as review the -[Test Replay](/guides/cloud/debugging/test-replay) and other artifacts like screenshots, +[Test Replay](/guides/cloud/test-replay) and other artifacts like screenshots, videos, and logs from your tests. The Debug page shows the latest completed -[test run](/guides/cloud/debugging/recorded-runs#Latest-Runs) that matches the `HEAD` commit +[test run](/guides/cloud/recorded-runs#Latest-Runs) that matches the `HEAD` commit (the commit currently checked out in the working directory) of your local project. Users can see and switch to relevant runs within the Debug page. If no run is found for your current commit, then Cypress shows the most recent run in @@ -217,7 +217,7 @@ information using /> You can receive notifications in the Cypress app for recorded runs directly from -Cypress Cloud. Learn more about [Cloud Run Notifications](/guides/cloud/debugging/recorded-runs#Notifications). +Cypress Cloud. Learn more about [Cloud Run Notifications](/guides/cloud/recorded-runs#Notifications). ## Test Runner diff --git a/docs/guides/core-concepts/writing-and-organizing-tests.mdx b/docs/guides/core-concepts/writing-and-organizing-tests.mdx index 9ec6a9333e7..ddac07164c5 100644 --- a/docs/guides/core-concepts/writing-and-organizing-tests.mdx +++ b/docs/guides/core-concepts/writing-and-organizing-tests.mdx @@ -247,9 +247,9 @@ module API option, if specified) /> Instead of administering assets yourself, you can -[save them to the cloud with Cypress Cloud](/guides/cloud/debugging/recorded-runs#Run-Details). +[save them to the cloud with Cypress Cloud](/guides/cloud/recorded-runs#Run-Details). -Replay the test as it executed during the recorded run with full debug capability using [ Test Replay](/guides/cloud/debugging/test-replay). +Replay the test as it executed during the recorded run with full debug capability using [ Test Replay](/guides/cloud/test-replay). Screenshots and videos are stored permanently, attached to their respective test results, and easily shared or browsed through our web interface. To learn more about videos and settings available, see @@ -826,7 +826,7 @@ it could be a user hitting this bug! alt="Cypress with a single failed test" /> -After a test fails, the [Test Replay](/guides/cloud/debugging/test-replay) or screenshots and videos with Cypress Cloud can help find the problem so it +After a test fails, the [Test Replay](/guides/cloud/test-replay) or screenshots and videos with Cypress Cloud can help find the problem so it can be fixed. ### Pending diff --git a/docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx b/docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx index af14f56465a..f72ca075221 100644 --- a/docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx +++ b/docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx @@ -161,7 +161,7 @@ the failure. Cypress assists with debugging in headless mode, in numerous ways: -- Replay the test as it executed during the recorded run with full debug capability using [Test Replay](/guides/cloud/debugging/test-replay) in Cypress Cloud. +- Replay the test as it executed during the recorded run with full debug capability using [Test Replay](/guides/cloud/test-replay) in Cypress Cloud. - By automatically taking a screenshot of the app UI and command log at the exact point of test failure. - To see everything that happened prior to test failure, enable the [`video`](/guides/references/configuration#Videos). diff --git a/docs/guides/guides/command-line.mdx b/docs/guides/guides/command-line.mdx index b8d75244cc1..f0c2f4ea50a 100644 --- a/docs/guides/guides/command-line.mdx +++ b/docs/guides/guides/command-line.mdx @@ -402,7 +402,7 @@ To force Cypress to render the Runner UI, use `--runner-ui`. cypress run --runner-ui ``` -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. +Useful for when [Test Replay](/guides/cloud/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 352f6320810..302bb1abecc 100644 --- a/docs/guides/guides/module-api.mdx +++ b/docs/guides/guides/module-api.mdx @@ -76,7 +76,7 @@ Just like the [Command Line options](/guides/guides/command-line) for | `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 `false` when [Test Replay](/guides/cloud/debugging/test-replay) is enabled. Otherwise defaults to `true`. | +| `runnerUi` | _boolean_ | Whether to display the Cypress Runner UI. Defaults to `false` when [Test Replay](/guides/cloud/test-replay) is enabled. Otherwise defaults to `true`. | | `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 | diff --git a/docs/guides/guides/screenshots-and-videos.mdx b/docs/guides/guides/screenshots-and-videos.mdx index 0e671290aa0..0eba53b285f 100644 --- a/docs/guides/guides/screenshots-and-videos.mdx +++ b/docs/guides/guides/screenshots-and-videos.mdx @@ -213,5 +213,5 @@ runs with the current run to ensure that nothing changed. - [Cypress.Screenshot](/api/cypress-api/screenshot-api) - [`cy.screenshot()`](/api/commands/screenshot) - [Cypress Cloud](/guides/cloud/introduction) -- [Test Replay](/guides/cloud/debugging/test-replay) +- [Test Replay](/guides/cloud/test-replay) - [Visual Testing](/guides/tooling/visual-testing) diff --git a/docs/guides/overview/why-cypress.mdx b/docs/guides/overview/why-cypress.mdx index e5affe8edee..a573e3f3f02 100644 --- a/docs/guides/overview/why-cypress.mdx +++ b/docs/guides/overview/why-cypress.mdx @@ -118,7 +118,7 @@ do that no other testing framework can: Say hello to fast, consistent and reliable tests that are flake-free. - **Screenshots, Videos, and Test Replay:** View screenshots taken automatically on failure, or videos, if enabled, of your entire test suite when run from the CLI. Record - to [Cypress Cloud](/guides/cloud/introduction) and replay the test as it executed during the run for zero-configuration debugging using [Test Replay](/guides/cloud/debugging/test-replay). + to [Cypress Cloud](/guides/cloud/introduction) and replay the test as it executed during the run for zero-configuration debugging using [Test Replay](/guides/cloud/test-replay). - **Cross Browser Testing:** Run tests within Firefox and Chrome-family browsers (including Edge and Electron) locally and [optimally in a Continuous Integration pipeline](/guides/guides/cross-browser-testing). diff --git a/docs/guides/references/changelog.mdx b/docs/guides/references/changelog.mdx index 656345767e2..3b4929bc711 100644 --- a/docs/guides/references/changelog.mdx +++ b/docs/guides/references/changelog.mdx @@ -44,11 +44,11 @@ _Released 08/29/2023_ **Summary:** -When recording to Cypress Cloud, users now receive our newest feature: [Test Replay](/guides/cloud/debugging/test-replay). Test Replay brings the debugging experience you know and love from the Cypress app directly into your recorded tests in Cypress Cloud. +When recording to Cypress Cloud, users now receive our newest feature: [Test Replay](/guides/cloud/test-replay). Test Replay brings the debugging experience you know and love from the Cypress app directly into your recorded tests in Cypress Cloud. Previously, trying to debug failures and flake in CI was painful and time consuming with only videos & screenshots. Test Replay provides a way to inspect the DOM, network events, and console logs of your application from your tests exactly as they ran in CI. -Test Replay is available in all Cypress Cloud plans. To start using Test Replay, simply record a run to Cypress Cloud. Learn more in the [Test Replay documentation](/guides/cloud/debugging/test-replay). +Test Replay is available in all Cypress Cloud plans. To start using Test Replay, simply record a run to Cypress Cloud. Learn more in the [Test Replay documentation](/guides/cloud/test-replay). Test Replay now serves as the primary replacement for debugging via video. Video capture and `videoCompression` of captured video are now set to `false` by default and `videoUploadOnPasses` is removed. @@ -147,14 +147,14 @@ _Released 07/06/2023_ **Features:** -- Cypress Cloud users can now receive [desktop notifications](/guides/cloud/debugging/recorded-runs#Notifications) about their runs, including when one starts, finishes, or fails. Addresses [#26686](https://github.com/cypress-io/cypress/issues/26686). +- Cypress Cloud users can now receive [desktop notifications](/guides/cloud/recorded-runs#Notifications) about their runs, including when one starts, finishes, or fails. Addresses [#26686](https://github.com/cypress-io/cypress/issues/26686). **Bugfixes:** - Fixed issues where commands would fail with the error `must only be invoked from the spec file or support file`. Fixes [#27149](https://github.com/cypress-io/cypress/issues/27149) and [#27163](https://github.com/cypress-io/cypress/issues/27163). - Fixed a regression introduced in Cypress [12.12.0](#12-12-0) where Cypress may fail to reconnect to the Chrome DevTools Protocol in Electron. Fixes [#26900](https://github.com/cypress-io/cypress/issues/26900). - Fixed an issue where chrome was not recovering from browser crashes properly. Fixes [#24650](https://github.com/cypress-io/cypress/issues/24650). -- Fixed a race condition that was causing a GraphQL error to appear on the [Debug page](/guides/cloud/debugging/recorded-runs#Debug) when viewing a running Cypress Cloud build. Fixed in [#27134](https://github.com/cypress-io/cypress/pull/27134). +- Fixed a race condition that was causing a GraphQL error to appear on the [Debug page](/guides/cloud/recorded-runs#Debug) when viewing a running Cypress Cloud build. Fixed in [#27134](https://github.com/cypress-io/cypress/pull/27134). - Fixed a race condition in electron where the test window exiting prematurely during the browser launch process was causing the whole test run to fail. Addressed in [#27167](https://github.com/cypress-io/cypress/pull/27167). - Fixed minor issues with Typescript types in the CLI. Fixes [#24110](https://github.com/cypress-io/cypress/issues/24110). - Fixed an issue where a value for the Electron debug port would not be respected if defined using the `ELECTRON_EXTRA_LAUNCH_ARGS` environment variable. Fixes [#26711](https://github.com/cypress-io/cypress/issues/26711). @@ -267,7 +267,7 @@ _Released 05/23/2023_ - Adds Git-related messages for the [Runs page](/guides/core-concepts/cypress-app#Runs) and - [Debug page](/guides/cloud/debugging/recorded-runs#Debug) when users aren't using Git or + [Debug page](/guides/cloud/recorded-runs#Debug) when users aren't using Git or there are no recorded runs for the current branch. Addresses [#26680](https://github.com/cypress-io/cypress/issues/26680). @@ -439,7 +439,7 @@ _Released 03/28/2023_ **Features:** -- The [Debug page](/guides/cloud/debugging/recorded-runs#Debug) now allows for navigating +- The [Debug page](/guides/cloud/recorded-runs#Debug) now allows for navigating between all runs recorded for a commit. Addresses [#25899](https://github.com/cypress-io/cypress/issues/25899) and [#26018](https://github.com/cypress-io/cypress/issues/26018). @@ -496,7 +496,7 @@ _Released 03/14/2023_ **Features:** -- The [Debug page](/guides/cloud/debugging/recorded-runs#Debug) is now able to show +- The [Debug page](/guides/cloud/recorded-runs#Debug) is now able to show real-time results from in-progress runs. Addresses [#25759](https://github.com/cypress-io/cypress/issues/25759). - Added the ability to control whether a request is logged to the command log diff --git a/docs/guides/references/migration-guide.mdx b/docs/guides/references/migration-guide.mdx index 8d8c0f9bc82..f9a699788ad 100644 --- a/docs/guides/references/migration-guide.mdx +++ b/docs/guides/references/migration-guide.mdx @@ -10,19 +10,19 @@ version 13. ### Cypress Cloud Test Replay -[Test Replay](/guides/cloud/debugging/test-replay) is enabled by default in `v13` of the Cypress App. +[Test Replay](/guides/cloud/test-replay) is enabled by default in `v13` 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](/guides/cloud/debugging/test-replay#Opt-out-of-Test-Replay) of this feature in Cloud project-level settings. +You can [opt-out](/guides/cloud/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 setting `video` to `true` either in your Cypress configuration or via [overriding options](/guides/references/configuration#Overriding-Options). This can be useful if you want video locally or want video for some other reason, like in non-Chromium browsers where [Test Replay](/guides/cloud/debugging/test-replay) is not available. +You can continue recording video by setting `video` to `true` either in your Cypress configuration or via [overriding options](/guides/references/configuration#Overriding-Options). This can be useful if you want video locally or want video for some other reason, like in non-Chromium browsers where [Test Replay](/guides/cloud/test-replay) is not available. :::cypress-config-example diff --git a/docs/partials/_ci_provider_cloud_steps.mdx b/docs/partials/_ci_provider_cloud_steps.mdx index 4d1100c42d1..0b742c67582 100644 --- a/docs/partials/_ci_provider_cloud_steps.mdx +++ b/docs/partials/_ci_provider_cloud_steps.mdx @@ -9,8 +9,8 @@ TODO: reuse this bulk of text for now until the Docusaurus v3 refactor. to Cypress Cloud. - In-depth and shareable - [test reports](/guides/cloud/debugging/recorded-runs#Latest-Runs). - - Visibility into test failures via quick access to [Test Replay](/guides/cloud/debugging/test-replay), error messages, stack + [test reports](/guides/cloud/recorded-runs#Latest-Runs). + - Visibility into test failures via quick access to [Test Replay](/guides/cloud/test-replay), error messages, stack traces, screenshots, videos, and contextual details. - [Integrating testing with the pull-request (PR) process](/guides/cloud/integrations/source-control/github) via diff --git a/docs/partials/_test-replay-info.mdx b/docs/partials/_test-replay-info.mdx index c95a5fa4b02..be3cdd0e01c 100644 --- a/docs/partials/_test-replay-info.mdx +++ b/docs/partials/_test-replay-info.mdx @@ -2,6 +2,6 @@ Debugging Cypress Cloud Test Runs? -Don't rely on artifact representations or reproducing failing conditions locally. Replay the test as it executed during the recorded run with full debug capability using [ Test Replay](/guides/cloud/debugging/test-replay). +Don't rely on artifact representations or reproducing failing conditions locally. Replay the test as it executed during the recorded run with full debug capability using [ Test Replay](/guides/cloud/test-replay). :::