Docs/readmes: add info about `minimumCoverageThresholds`

danielpalme / ReportGenerator

ReportGenerator converts coverage reports generated by coverlet, OpenCover, dotCover, Visual Studio, NCover, Cobertura, JaCoCo, Clover, gcov or lcov into human readable reports in various formats.

https://reportgenerator.io

Apache License 2.0

2.56k stars 279 forks source link

Docs/readmes: add info about `minimumCoverageThresholds` #671

Closed alexandrehtrb closed 3 months ago

alexandrehtrb commented 3 months ago

I was looking for this feature but couldn't find it in README nor the main website; only found in the wiki.

It would be good to document it in:

ReportGenerator readme
GitHub Action readme
Main website -> usage

danielpalme commented 3 months ago

Documenting and maintaining all settings in all those locations could become tedious.

Instead I added the following text to all the locations you suggested:

The more advanced settings are documented in the wiki.

Thanks for your hint!

alexandrehtrb commented 3 months ago

It would be good to at least add this info in the GitHub Action readme, because people use code coverage to fail CI/CD when below the thresholds... irongut/CodeCoverageSummary for example