purpose

update badge jacoco coverage (svg file, badgen.net, shields.io etc or just text).

if used

commits (as ${GITHUB_ACTOR}) the latest svg doc/badges/coverage.svg file or covergate text value (or badge) in the readme file

  • optional parameter readmeFileName - defaults to readme.md
  • optional parameter jacocoFileName - defaults to target/site/jacoco/jacoco.xml
  • define badge layout : _defaultGreenMinim 0.7 - green/_defaultMinim - yellow/less - red
  • optional supportedTypes : svg, text (markdown?), badge - defaults to svg, text, or shields.io badge

TODOs

  • txt,badge support (update readme/commit), svg (update svg readme/commit)
  • commit coverage to wiki ?
  • add badge default (if not found - default path : doc/badges/coverage.svg, last coverage %) ?
  • add coverage summary ?
    • export coverage to MD ?
    • modify original coverage (xml/html) summary to MD or
  • svg/badge should have same threshold for coverage style (green/yellow/red)
    • default minimum coverage : 0.6; coverage badge will be 'green' when the total coverage > 'minim' configured value and total coverage >= from previous coverage value svg : green/yellow/red
    • badge green:url/yellow:url/red:url (defaults)
    • text : coverage :
- 00.00% 
+ 99.00%
! text in orange

or

coverage : [ ${\textsf{\color{red}00.00}}$ % ] coverage : [ ${\textsf{\color{yellow}62.00}}$ % ] coverage : [ ${\textsf{\color{green}99.00}}$ % ]

related

python : https://github.com/cicirello/jacoco-badge-generator?tab=readme-ov-file (badge samples)