clearlyip/Code Coverage Report Difference

Provides code coverage reports with the ability to see differences in a pull requests utilizing markdown files.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
filenameCode Coverage file to process (with extension)yes
github_tokenGitHub token. This is sometimes needed on private repositoriesno${{ github.token }}
only_list_changed_filesOnly list changed filesnofalse
markdown_filenameThe filename (without extension) for the resulting markdown file. Default is code-coverage-results.nocode-coverage-results
badgeInclude a coverage badge in the output using shields.io - true / false (default).nofalse
overall_coverage_fail_thresholdFail if overall coverage below lower threshold percentage. The default value is 0no0
file_coverage_error_minThreshold used to determine when coverages less than this value should be marked redno50
file_coverage_warning_maxThreshold used to determine when coverages less than this value should be marked orange. Above this will be marked greenno75
fail_on_negative_differenceFail if any difference is a negative value (Coverage was reduced)nofalse
artifact_download_workflow_namesComma Separated list of workflow names to look for artifacts in. If left empty will only look at the current workflowno
artifact_nameArtifact name. Use %name% as a placeholder (must be included!)nocoverage-%name%
negative_difference_byDetermines how negative difference is evaluated. Possible values are "overall" and "package" (default)nopackage
negative_difference_thresholdThe percentage drop in coverage that should be allowed. The default value is 0.no0
retention_daysThe number of days to retain uploaded artifacts. When `undefined` (default), the default retention period for the repository is used.no
without_base_coverage_templatePath to custom template without base coverageno
with_base_coverage_templatePath to custom template with base coverageno
show_coverage_by_top_dirWhen true, aggregate coverage by the first path segment (e.g. src/, tests/, (root)). Takes precedence over coverage_depth and show_coverage_by_parent_dir.nofalse
coverage_depthWhen set (e.g. 2), aggregate by path to this depth (1=first segment, 2=first two segments). Ignored if show_coverage_by_top_dir is true. Takes precedence over show_coverage_by_parent_dir.no""
show_coverage_by_parent_dirWhen true, aggregate coverage by the parent directory of each file (e.g. src/common/, src/aws/). Ignored if show_coverage_by_top_dir or coverage_depth is set.nofalse
exclude_pathsComma-separated path prefixes to exclude from coverage (e.g. tests/, e2e/, docs/). Files whose relative path starts with any prefix are excluded from the report and from overall coverage.no""
namedescription
fileThe generated markdown file path
coverageThe overall coverage of the project as a percentage