Skip to content

BREAKING: remove the videoUploadOnPasses configuration option #5306

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

Merged
merged 2 commits into from
Jun 20, 2023
Merged

BREAKING: remove the videoUploadOnPasses configuration option #5306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65aadb4
BREAKING: remove the videoUploadOnPasses configuration option
AtofStryker Jun 13, 2023
ed5d0d1
chore: add history entry of removed videoUploadOnPasses config option
AtofStryker Jun 13, 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
1 change: 0 additions & 1 deletion docs/guides/guides/module-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,6 @@ tests results. A typical run could return something like this:
}],
"reporter": "spec",
"reporterStats": {...},
"shouldUploadVideo": true,
"spec": {...},
"stats": {
"suites": 1,
Expand Down
12 changes: 6 additions & 6 deletions docs/guides/guides/screenshots-and-videos.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ Videos are stored in the
When using the `--record` flag while running your tests, videos are processed,
compressed, and uploaded to [Cypress Cloud](/guides/cloud/introduction) after
every spec file runs, successful or not. To change this behavior to only process
videos in the case that tests fail, set the
[`videoUploadOnPasses`](/guides/references/configuration#Videos) configuration
option to `false`.
videos in the case that tests fail, see how to
[delete videos for specs without failing or retried tests](/guides/guides/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests).
Deleting the video will cause the video to not be uploaded to Cypress Cloud.

Cypress clears any existing videos before a `cypress run`. If you do not want to
clear your videos folder before a run, you can set
Expand Down Expand Up @@ -143,9 +143,9 @@ to Cypress Cloud. Deleting videos after the run can save resource space on the
machine as well as skip the time used to process, compress, and upload the video
to [Cypress Cloud](/guides/cloud/introduction).

To only process videos in the case that a test fails, you can set the
[`videoUploadOnPasses`](/guides/references/configuration#Videos) configuration
option to `false`.
To only process videos in the case that a test fails, you can
[delete videos for specs without failing or retried tests](/guides/guides/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests),
which will not upload the video of passed runs to Cypress Cloud.

For more fine grained control, you can use Cypress's
[`after:spec`](/api/plugins/after-spec-api) event listener that fires after each
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/references/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ For more options regarding screenshots, view the
| `videoCompression` | `false` | 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). |
| `videosFolder` | `cypress/videos` | Where Cypress will automatically save the video of the test run when tests run with `cypress run`. |
| `video` | `false` | Whether Cypress will capture a video of the tests run with `cypress run`. |
| `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. |
Copy link
Member

@emilyrohrbough emilyrohrbough Jun 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a history note that this configuration option was removed in v13.0.0

Copy link
Contributor Author

@AtofStryker AtofStryker Jun 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilyrohrbough added in e6325f6


### Downloads

Expand Down Expand Up @@ -741,6 +740,7 @@ DEBUG=cypress:cli,cypress:server:specs

| Version | Changes |
| --------------------------------------------- | ------------------------------------------------------------------------------------- |
| [13.0.0](/guides/references/changelog#13-0-0) | Removed `videoUploadOnPasses` option. |
| [11.0.0](/guides/references/changelog#11-0-0) | Removed `e2e.experimentalSessionAndOrigin` option. |
| [10.4.0](/guides/references/changelog#10-4-0) | Added `e2e.testIsolation` option. |
| [10.0.0](/guides/references/changelog#10-0-0) | Reworked page to support new `cypress.config.js` and deprecated `cypress.json` files. |
Expand Down