Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update v13 content urls #5428

Merged
merged 3 commits into from
Aug 25, 2023
Merged

docs: update v13 content urls #5428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e944361
update content urls
jaffrepaul Aug 22, 2023
eee6eb4
add todo
jaffrepaul Aug 22, 2023
c21e915
replace v13 changelog urls
jaffrepaul Aug 25, 2023
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
26 changes: 13 additions & 13 deletions docs/api/commands/screenshot.mdx
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/faq/questions/cloud-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ Yes! The test is captured in Cypress Cloud as it executed in your CI run. That m

### <Icon name="angle-right" /> 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).

### <Icon name="angle-right" /> Is every aspect of my stack included in Test Replay?

Expand Down
9 changes: 2 additions & 7 deletions docs/guides/cloud/debugging/test-replay.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ sidebar_position: 20

:::caution

{/* todo: change changelog url to real page when it's ready/won't break build */} <br/>
&#8239;<Icon name="exclamation-triangle" /> 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).
&#8239;<Icon name="exclamation-triangle" /> 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.

Expand Down Expand Up @@ -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)
56 changes: 28 additions & 28 deletions docs/guides/guides/command-line.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <autoCancelAfterFailures>` {#auto-cancel-after-runs}

Expand Down Expand Up @@ -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 <spec>` {#cypress-run-spec-lt-spec-gt}

Expand Down
Loading