From 276bc716a7ee344df2c7f2c569aa44e00c300519 Mon Sep 17 00:00:00 2001 From: Paulo Ribeiro <60105800+pauloribeiro-codacy@users.noreply.github.com> Date: Mon, 13 Apr 2020 08:58:28 +0100 Subject: [PATCH] Add workaround for dotCover coverage reports that are too big (#197) * feature: Add workaround for dotCover reports that are too large * fix: Format title more consistently with other Troubleshooting sections * fix: Reword workaround instructions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b9d1216a..cc0f2cb8 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,16 @@ For a complete list of commands and options: `--help` ## Troubleshooting +### `JsonParseException` while uploading C# coverage data + +If you're using dotCover to generate coverage reports for your C# projects, you should [exclude xUnit files](https://www.jetbrains.com/help/dotcover/Running_Coverage_Analysis_from_the_Command_LIne.html#filters_cmd) from the coverage analysis as follows: + +```bash +dotCover.exe cover ... /Filters=-:xunit* +``` + +By default, dotCover includes xUnit files in the coverage analysis and this results in larger coverage reports. This filter helps ensure that the resulting coverage data does not exceed the size limit accepted by the Codacy API when uploading the results. + ### `Failed to upload report: Not Found` Error when running the command, then you'll probably have codacy-coverage-reporter 1.0.3 installed.