Configure codecov to simplify PR comments #3428
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We currently use Codecov for test coverage reporting, which works nicely in general, but its default template for PR comments is much too verbose, especially since our use of property-based testing means there are often many files with small differences in coverage that show up in the report.
The result is that at the top of every PR thread there's an enormous comment that fills a screen or more and must be scrolled past to get to actual discussion.
I'm tempted to disable the PR comments entirely, and instead just have large changes in coverage fail the build. The reports would still be available on Codecov for anyone who needs them. Before we consider doing that, though, I thought we could try the smaller change here, which just removes the (often very long)
reach
,flags
, andfile
sections from the PR comment. It also disables commenting when there are no changes to coverage, but I think that's unlikely to apply often because of property-based testing coverage noise.