breaking: update documentation by setting videoCompression: false #5301

AtofStryker · 2023-06-13T02:48:58Z

updates the videoCompression 32 CRF configuration to false by default and other relevant documentation to the change. see cypress-io/cypress#27009

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

chrisbreiding · 2023-06-15T13:54:03Z

docs/guides/references/configuration.mdx

@@ -124,7 +124,7 @@ For more options regarding screenshots, view the
 | Option                  | Default          | Description                                                                                                                                                                                                                                                                                                              |
 | ----------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `trashAssetsBeforeRuns` | `true`           | Whether Cypress will trash assets within the `downloadsFolder`, `screenshotsFolder`, and `videosFolder` before tests run with `cypress run`.                                                                                                                                                                             |
-| `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).                                                                     |
+| `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).                                                                     |


I think this should also mention that true is valid and sets the value to 32 CRF.

This is handled in the release-12.15.0 branch. It just hasn't made its way into main yet. Once released, we will need to merge main into the v13 docs branch to make sure the language makes sense

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>

…ess-io/cypress-documentation into breaking/video_compression_breaking

emilyrohrbough · 2023-06-15T14:58:25Z

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

-After `cypress run` completes, Cypress compresses the video in order to save on
-file size. By default it compresses to a `32 CRF`, but this is configurable with
-the [`videoCompression`](/guides/references/configuration#Videos) property.
+After `cypress run` completes, videos are not compressed by default. However,


Know this will be paired with Video False, we should go ahead and make this align. Something like:

Cypress has the capabilities to compress recorded videos after a run to reduce the video file size. By default, compression is turned off, which results in a larger file size and better video quality. You can enable video compression with the videoCompression configuration option to reduce the file size. This will also reduce the video quality and take slightly longer to process and complete the run.

actually reading below, this sentence seems unnecessary. There is an entire section dedicated to this that needs some updates. The intro suggests we encode by default. I'd also expect the enabling video encoding to come before changing the encoding value since it's off or on w/ 32 or custom to the user's preference.

@emilyrohrbough should we just remove it?

I'm currently working on revamping the encoding section

emilyrohrbough · 2023-06-15T15:00:26Z

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

-After `cypress run` completes, Cypress compresses the video in order to save on
-file size. By default it compresses to a `32 CRF`, but this is configurable with
-the [`videoCompression`](/guides/references/configuration#Videos) property.
+After `cypress run` completes, videos are not compressed by default. However,


actually reading below, this sentence seems unnecessary. There is an entire section dedicated to this that needs some updates. The intro suggests we encode by default. I'd also expect the enabling video encoding to come before changing the encoding value since it's off or on w/ 32 or custom to the user's preference.

AtofStryker · 2023-06-15T18:51:03Z

@emilyrohrbough I tried reworking the Video Encoding section in 1ba1025. I still think it needs work, but it seems like an improvement? What do you think?

AtofStryker · 2023-06-15T20:13:24Z

I need to rebase this

… into breaking/video_compression_breaking

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

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

emilyrohrbough · 2023-06-15T21:26:56Z

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

+If the machine is encoding the video slowly (which is often the case for virtual
+machines that use less CPU cores), the encoding might take a long time. In this


messy suggestion but your current paragraph hangs. / doesn't list common scenarios:

Suggested change

If the machine is encoding the video slowly (which is often the case for virtual

machines that use less CPU cores), the encoding might take a long time. In this

**Change compression value from 32**

In addition to enabling or disabling video compress, you can specify the CRF value used to compress the video. Here is some common scenario:

- If the machine is encoding the video slowly (which is often the case for virtual

machines that use less CPU cores), increase(??) the CRF value to .....

- If your videos are extremely low quality, try decreasing the CRF value....

gave this a shot in 206a57c

…ess-io/cypress-documentation into breaking/video_compression_breaking

AtofStryker · 2023-06-20T18:13:42Z

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

@@ -58,14 +58,12 @@ If enabled, Cypress records a video for each spec file when running tests during
 }
 ```

+:::cypress-config-example


this was missing from the video configuration example which broke the others which I missed in the previous PR

Emily is OOO for an extended period of time and changes should be addressed

* BREAKING: update documentation by setting default video: false for v13.0.0 (#5300) * BREAKING: update documentation by setting default video: false * Update docs/guides/overview/why-cypress.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/continuous-integration/introduction.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Update docs/guides/guides/screenshots-and-videos.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: re-order video bits * Update docs/guides/end-to-end-testing/migration/protractor-to-cypress.mdx * chore: linting --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * breaking: update documentation by setting videoCompression: false (#5301) * BREAKING: update documentation by setting default video: false * BREAKING: update documentation by setting videoCompression: false * Update docs/guides/guides/screenshots-and-videos.mdx Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> * apply suggestion from code review * chore: attempt to rework the video encoding section * Update docs/guides/guides/screenshots-and-videos.mdx Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * chore: address comments in code review * chore: update video encoding guide to flow a bit more evenly --------- Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * BREAKING: remove the videoUploadOnPasses configuration option (#5306) * BREAKING: remove the videoUploadOnPasses configuration option * chore: add history entry of removed videoUploadOnPasses config option * .readFile() is now a query (#5017) (#5316) * .readFile() is now a query * Add section on new .readFile() superpowers * Fix page slug for readFile * Prettier run Co-authored-by: Blue F <blue@everblue.info> * Update guides for Cy 13, where assertions are now commands (#5081) * .readFile() is now a query (#5017) * .readFile() is now a query * Add section on new .readFile() superpowers * Fix page slug for readFile * Prettier run * Update guides to better support users in Cy 13, where assertions are now commands * Review updates * Apply suggestions from code review Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> * Partial review feedback (more to come) * Review updates * Prettier run * fix: update retry ability guide and migration guide now that should() and and() will not be queries in v13. see cypress-io/cypress#25738 * chore: correct number of queries in example * revert: images changes due to should() and and() being queries, which is no longer applicable due to cypress-io/cypress#25738 * chore: lint guides --------- Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Bill Glesias <bglesias@gmail.com> * Apply suggestions from code review Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * Remove nodeVersion documentation (#5318) * Remove reference to 'nodeVersion' * added history, removed changes to legacy * docs: v13 video and TR migration info (#5383) * added video config migration info * added tr migration info * PR feedback * PR feedback * PR feedback * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * Update docs/guides/references/migration-guide.mdx Co-authored-by: Jennifer Shehane <jennifer@cypress.io> --------- Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * Update results for module API and after:spec handler (#5379) * docs: adding documentation for runner-ui cli flags (#5424) * docs: test replay docs (#5349) * sidebar content shuffle * main feature content & link updates * add screenshots * add url to vpn whitelist * add TR banner * add & reorder faq * build test replay partial * add TR partial to related content * add TR link to related "see more" sections * content tweaks * include TR content in body copy * add troubleshooting * remove old images * add PR feedback * add command log notes * remove dead link * update images * replace runs page screenshots * Apply suggestions from code review Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * add more faqs * restore missing partial export * fix links * swap in screenshot of new network panel * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * fix command line merge issue * lint * Update docs/guides/cloud/debugging/recorded-runs.mdx Co-authored-by: Bill Glesias <bglesias@gmail.com> * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> --------- Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Bill Glesias <bglesias@gmail.com> * Fix JavaScript caps * Fix caps of JavaScript * Fix typo * Write a document around Cloud data storage and controls (#5425) Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com> Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * add changelog, remove node 16 support, and update docker image refere… (#5434) * add changelog, remove node 16 support, and update docker image reference to be on at least node 18 * Update docs/guides/references/changelog.mdx * docs: minor v13 updates (#5438) * match data callout with data storage page * remove mention from artifacts panel * remove submitting feature requests callout * build & insert cloud free plan partial * docs: update v13 content urls (#5428) * update content urls * add todo * replace v13 changelog urls * docs: v13 changelog summary (#5441) * changelog summary * Update docs/guides/references/changelog.mdx Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * tweak verbaige & lint --------- Co-authored-by: Jennifer Shehane <jennifer@cypress.io> * Apply suggestions from code review Co-authored-by: Bill Glesias <bglesias@gmail.com> * lint * Update docs/faq/questions/cloud-faq.mdx Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> * include TR note in cypress screenshot api options (#5445) * docs: additional test replay content (#5447) * add TR cost faq * add centos troubleshooting * sync up changelog * Update _cloud_free_plan.mdx minor text update --------- Co-authored-by: Bill Glesias <bglesias@gmail.com> Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com> Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com> Co-authored-by: Blue F <blue@everblue.info> Co-authored-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Co-authored-by: Paul Jaffre <jaffrepaul@gmail.com> Co-authored-by: Jennifer Shehane <jennifer@cypress.io> Co-authored-by: Matt Schile <mschile@cypress.io> Co-authored-by: Chris Breiding <chrisbreiding@gmail.com> Co-authored-by: Paul Jaffre <paul@cypress.io>

AtofStryker added 2 commits June 12, 2023 22:22

BREAKING: update documentation by setting default video: false

0bbb65e

BREAKING: update documentation by setting videoCompression: false

a3b37fa

AtofStryker mentioned this pull request Jun 13, 2023

breaking: video compression false cypress-io/cypress#27009

Merged

3 tasks

chrisbreiding requested changes Jun 15, 2023

View reviewed changes

AtofStryker and others added 3 commits June 15, 2023 10:25

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

09b0af3

Co-authored-by: Chris Breiding <chrisbreiding@users.noreply.github.com>

apply suggestion from code review

f94affc

Merge branch 'breaking/video_compression_breaking' of github.com:cypr…

d9c273c

…ess-io/cypress-documentation into breaking/video_compression_breaking

AtofStryker requested a review from chrisbreiding June 15, 2023 14:30

chrisbreiding approved these changes Jun 15, 2023

View reviewed changes

emilyrohrbough reviewed Jun 15, 2023

View reviewed changes

emilyrohrbough previously requested changes Jun 15, 2023

View reviewed changes

chore: attempt to rework the video encoding section

1ba1025

Base automatically changed from chore/video_defaults_breaking to v13.0.0 June 15, 2023 19:16

AtofStryker requested a review from emilyrohrbough June 15, 2023 20:12

Merge branch 'v13.0.0' of github.com:cypress-io/cypress-documentation…

1d2e090

… into breaking/video_compression_breaking

emilyrohrbough reviewed Jun 15, 2023

View reviewed changes

docs/guides/guides/screenshots-and-videos.mdx Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jun 15, 2023

View reviewed changes

docs/guides/guides/screenshots-and-videos.mdx Outdated Show resolved Hide resolved

emilyrohrbough reviewed Jun 15, 2023

View reviewed changes

docs/guides/guides/screenshots-and-videos.mdx Outdated Show resolved Hide resolved

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

6a933ae

Co-authored-by: Emily Rohrbough <emilyrohrbough@users.noreply.github.com>

emilyrohrbough reviewed Jun 15, 2023

View reviewed changes

AtofStryker added 3 commits June 20, 2023 12:29

chore: address comments in code review

718e748

Merge branch 'breaking/video_compression_breaking' of github.com:cypr…

9a2f58d

…ess-io/cypress-documentation into breaking/video_compression_breaking

chore: update video encoding guide to flow a bit more evenly

206a57c

AtofStryker commented Jun 20, 2023

View reviewed changes

Merge branch 'v13.0.0' into breaking/video_compression_breaking

df1e854

AtofStryker merged commit 48c2a95 into v13.0.0 Jun 20, 2023
8 checks passed

AtofStryker deleted the breaking/video_compression_breaking branch June 20, 2023 19:10

jennifer-shehane mentioned this pull request Jul 19, 2023

BREAKING: 13.0 Docs #5315

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

breaking: update documentation by setting videoCompression: false #5301

breaking: update documentation by setting videoCompression: false #5301

AtofStryker commented Jun 13, 2023

chrisbreiding Jun 15, 2023

AtofStryker Jun 15, 2023

emilyrohrbough Jun 15, 2023

emilyrohrbough Jun 15, 2023

AtofStryker Jun 15, 2023

AtofStryker Jun 15, 2023

emilyrohrbough Jun 15, 2023

AtofStryker commented Jun 15, 2023

AtofStryker commented Jun 15, 2023

emilyrohrbough Jun 15, 2023

AtofStryker Jun 20, 2023

AtofStryker Jun 20, 2023

		If the machine is encoding the video slowly (which is often the case for virtual
		machines that use less CPU cores), the encoding might take a long time. In this

-If the machine is encoding the video slowly (which is often the case for virtual
-machines that use less CPU cores), the encoding might take a long time. In this
+**Change compression value from 32**
+In addition to enabling or disabling video compress, you can specify the CRF value used to compress the video. Here is some common scenario:
+- If the machine is encoding the video slowly (which is often the case for virtual
+machines that use less CPU cores), increase(??) the CRF value to .....
+- If your videos are extremely low quality, try decreasing the CRF value....

breaking: update documentation by setting videoCompression: false #5301

breaking: update documentation by setting videoCompression: false #5301

Conversation

AtofStryker commented Jun 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AtofStryker commented Jun 15, 2023

AtofStryker commented Jun 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment