Skip to content

Commit 1acf0a4

Browse files
committed
BREAKING: update documentation by setting default video: false
1 parent 3317a0d commit 1acf0a4

File tree

6 files changed

+19
-10
lines changed

6 files changed

+19
-10
lines changed

docs/api/commands/screenshot.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Another potential problem to be aware of is that our own Command Log is using
278278
React under the hood and only rendering asynchronously during an animation
279279
frame. It is possible you will see screenshots taken before our Command Log is
280280
done rendering. This means you may not see the **error displayed** in the
281-
screenshot. But this is also why we take a video - to show you the complete
281+
screenshot. But this is also why we allow taking a video - to show you the complete
282282
failure.
283283

284284
We make our best effort to synchronize taking a screenshot with our renderer,

docs/guides/continuous-integration/introduction.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ insight into what happened when your tests ran.
170170
- Get the entire stack trace of failed tests.
171171
- View screenshots taken when tests fail and when using
172172
[`cy.screenshot()`](/api/commands/screenshot).
173-
- Watch a video of your entire test run or a clip at the point of test failure.
173+
- If enabled, watch a video of your entire test run or a clip at the point of test failure.
174174
- See which machines ran each test when
175175
[parallelized](/guides/guides/parallelization).
176176

@@ -376,6 +376,7 @@ values in the Cypress configuration.
376376
**_Typical use cases would be modifying things like:_**
377377

378378
- `CYPRESS_BASE_URL`
379+
- `CYPRESS_VIDEO`
379380
- `CYPRESS_VIDEO_COMPRESSION`
380381
- `CYPRESS_REPORTER`
381382
- `CYPRESS_INSTALL_BINARY`

docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ the state of the app UI at the point of failure or see the events that led up to
156156
the failure.
157157

158158
Cypress assists with debugging in headless mode, by automatically taking a
159-
screenshot of the app UI and command log at the exact point of test failure. To
159+
screenshot of the app UI and command log at the exact point of test failure. If enabled, to
160160
help see everything that happened prior to test failure, Cypress provides a
161161
video recording (as an MP4 file) of a full test spec run by default.
162162

docs/guides/guides/screenshots-and-videos.mdx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,26 @@ to clear your screenshots folder before a run, you can set
4343

4444
## Videos
4545

46-
Cypress records a video for each spec file when running tests during
47-
`cypress run`. Videos are _not_ automatically recorded during `cypress open`.
46+
If enabled, Cypress records a video for each spec file when running tests during
47+
`cypress run`. Videos are _not_ recorded during `cypress open`.
4848

49-
Video recording can be turned off entirely by setting
50-
[`video`](/guides/references/configuration#Videos) to `false` from within your
49+
Video recording can be turned on by setting
50+
[`video`](/guides/references/configuration#Videos) to `true` from within your
5151
configuration.
5252

53+
:::cypress-config-example
54+
55+
```ts
56+
{
57+
video: true
58+
}
59+
```
60+
5361
Videos are stored in the
5462
[`videosFolder`](/guides/references/configuration#Videos) which is set to
5563
`cypress/videos` by default.
5664

57-
After `cypress run` completes, Cypress automatically compresses the video in
65+
After `cypress run` completes, Cypress compresses the video in
5866
order to save on file size. By default it compresses to a `32 CRF`, but this is
5967
configurable with the
6068
[`videoCompression`](/guides/references/configuration#Videos) property.

docs/guides/overview/why-cypress.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ do that no other testing framework can:
117117
- **Consistent Results:** Our architecture doesn't use Selenium or WebDriver.
118118
Say hello to fast, consistent and reliable tests that are flake-free.
119119
- **Screenshots and Videos:** View screenshots taken automatically on failure,
120-
or videos of your entire test suite when run from the CLI. Record to
120+
or videos, if enabled, of your entire test suite when run from the CLI. Record to
121121
[Cypress Cloud](/guides/cloud/introduction) to store them with your test
122122
results for zero-configuration debugging.
123123
- **Cross Browser Testing:** Run tests within Firefox and Chrome-family browsers

docs/guides/references/configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ For more options regarding screenshots, view the
126126
| `trashAssetsBeforeRuns` | `true` | Whether Cypress will trash assets within the `downloadsFolder`, `screenshotsFolder`, and `videosFolder` before tests run with `cypress run`. |
127127
| `videoCompression` | `32` | The quality setting for the video compression, in Constant Rate Factor (CRF). The value can be `false` to disable compression or a value between `0` and `51`, where a lower value results in better quality (at the expense of a higher file size). |
128128
| `videosFolder` | `cypress/videos` | Where Cypress will automatically save the video of the test run when tests run with `cypress run`. |
129-
| `video` | `true` | Whether Cypress will capture a video of the tests run with `cypress run`. |
129+
| `video` | `false` | Whether Cypress will capture a video of the tests run with `cypress run`. |
130130
| `videoUploadOnPasses` | `true` | Whether Cypress will process, compress, and upload videos to [Cypress Cloud](/guides/cloud/introduction) even when all tests in a spec file are passing. This only applies when recording your runs to Cypress Cloud. Turn this off if you'd like to only upload the spec file's video when there are failing tests. |
131131

132132
### Downloads

0 commit comments

Comments
 (0)