Skip to content

Commit a0589b4

Browse files
committed
Add README instructions for using the batching environment variable
1 parent 339deb3 commit a0589b4

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -549,14 +549,21 @@ Deeply nested objects will sometimes have `[object Object]` values printed. You
549549
DEBUG_DEPTH=10 DEBUG=code-coverage npm run dev
550550
```
551551

552-
### Common issues
552+
## Common issues
553553

554554
Common issue: [not instrumenting your application when running Cypress](#instrument-your-application).
555555

556556
If the plugin worked before in version X but stopped after upgrading to version Y, please try the [released versions](https://github.com/cypress-io/code-coverage/releases) between X and Y to see where the breaking change was.
557557

558558
If you decide to open an issue in this repository, please fill in all information the [issue template](https://github.com/cypress-io/code-coverage/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) asks for. The issues most likely to be resolved have debug logs, screenshots, and hopefully public repository links so we can try running the tests ourselves.
559559

560+
### Coverage reporting timeouts
561+
562+
If the plugin times out when sending coverage report data to be merged, this may be due to a very large
563+
report being sent across processes. You can batch the report by setting the `sendCoverageBatchSize` environment
564+
variable in your `cypress.config.js` file's 'env' section. Assign the variable an integer value representing
565+
the number of report keys to send per batch.
566+
560567
## Contributing
561568

562569
You can test changes locally by running tests and confirming that the code coverage has been calculated and saved.

0 commit comments

Comments
 (0)