Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: cypress-io/code-coverage
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 3baba20fd6821b13176912a0536a220453ab2bac
Choose a base ref
..
head repository: cypress-io/code-coverage
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 1504f4de2da7d424b6a3ad93bf8a0678d1574944
Choose a head ref
2 changes: 2 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -146,6 +146,7 @@ workflows:
jobname:
- all-files
- backend
- batch-send-coverage
- before-all-visit
- before-each-visit
- cra-e2e-and-ct
@@ -174,6 +175,7 @@ workflows:
- test-code-coverage-plugin
- test-all-files
- test-backend
- test-batch-send-coverage
- test-before-all-visit
- test-before-each-visit
- test-cra-e2e-and-ct
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -549,14 +549,21 @@ Deeply nested objects will sometimes have `[object Object]` values printed. You
DEBUG_DEPTH=10 DEBUG=code-coverage npm run dev
```

### Common issues
## Common issues

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

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.

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.

### Coverage reporting timeouts

If the plugin times out when sending coverage report data to be merged, this may be due to a very large
report being sent across processes. You can batch the report by setting the `sendCoverageBatchSize` environment
variable in your `cypress.config.js` file's 'env' section. Assign the variable an integer value representing
the number of report keys to send per batch.

## Contributing

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