-
-
Notifications
You must be signed in to change notification settings - Fork 283
FAQ
ReportGenerator does not gather any user data. No statistics, telemetry or other tracking data is collected. The tool operates strictly locally.
Use the online configuration tool to get started quickly.
HtmlSummary creates a single HTML file summary.htm (without links).
Html creates the summary as index.htm (with links) and detailed reports for each class.
Learn more about Output formats and have a look at the sample reports.
If you use the Azure Devops extension you may notice, that some settings are not applied in the generated report in the 'Code Coverage' tab of the build results.
That happens if you use the Publish Code Coverage Results task from Microsoft. It regenerates the report with different settings and based on the supplied Coberatura file (see announcement). Moreover it does not necessarily use the latest version of ReportGenerator.
To disable the regeneration of the report, you can use the following environment variable in your build:
disable.coverage.autogenerate: 'true'
More details can be found here.
Just ask or learn how to create Custom reports.
Here you find some samples:
- https://github.com/danielpalme/ReportGenerator/issues/158
- https://github.com/danielpalme/ReportGenerator/issues/21
Yes, you can change them with some Settings.
Line coverage | Branch coverage | Coverage by test method | # Method metrics | |
---|---|---|---|---|
OpenCover | x | x | x | 5 |
PartCover | x 1) | 0 | ||
dotCover | x | 0 | ||
Visual Studio | x | 2 | ||
NCover | x | 0 | ||
Cobertura | x | x | 3 | |
Clover | x | x | 1 | |
JaCoCo | x | x | 2 | |
Mbprof | x 2) | 0 | ||
gcov | x | x | 0 | |
lcov | x | x | 0 |
1) PartCover is only supported in ReportGenerator until version 3.x
2) Only basic line coverage support possible, since XML files generated by mbprof only contain coverage information about lines in code elements that have been executed at least once.
If you get the following exception when you try to install the latest version of ReportGenerator:
Could not install package 'ReportGenerator'. You are trying to install this package into a project that targets '.NETFramework,Version=v4.x', but the package does not contain any assembly references or content files that are compatible with that framework. For more information, contact the package author.
To fix this, make sure that your Nuget version is up to date. By installing the latest Visual Studio version you also get the latest version of Nuget. Or you download Nuget from nuget.org.
If you use the Nuget package you won't have any problems. It only happens when you use the ZIP download. Make sure to unblock the ZIP file before extracting it.
Since version 2.0.4 this should happen automatically.