codecov-action icon indicating copy to clipboard operation
codecov-action copied to clipboard

README needs to document what file format coverage is expected in, and how the search for coverage files works

Open dabrahams opened this issue 1 year ago • 5 comments

My system generates .json files by default. They can be converted to XML, which appears in the README examples but it's not clear whether that's a requirement of your system or not. It's also not clear where the plugin will search for these coverage files by default.

dabrahams avatar Feb 27 '24 22:02 dabrahams

Agreed this would be an improvement ... the readme documents that files is an optional argument -- so presumably there is some default rules/pattern here -- but doesn't say what the default selection will be. I'm guessing it's something like *coverage*xml or similar pattern?

mjankowski avatar Apr 22 '24 16:04 mjankowski

You're asking me? I filed this because I don't know(!)

dabrahams avatar Apr 25 '24 23:04 dabrahams

Please accept my apologies. I'm not asking you, I'm joining you in the increasingly vocal chorus of voices who don't know what files are selected by default and would love to be told.

mjankowski avatar Apr 26 '24 13:04 mjankowski

Thanks for response!

Default file patterns can be found here

...this seems to show how supplied paths would be regexp-processed ... but not what the default search locations for files/dirs is?

mjankowski avatar May 08 '24 16:05 mjankowski