lepusinc/Report Code Coverage
Reads coverage report files matched by a glob pattern and outputs a summary to GitHub Step Summary. Optionally downloads coverage artifacts from prior jobs before reading.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| file | Glob pattern matching coverage report files to read (e.g. "**/clover.xml"). Currently Clover XML is supported. | yes | — |
| artifact | YAML or JSON configuration passed to actions/download-artifact to fetch coverage artifacts before reading. Leave empty to skip artifact download and read files already present in the workspace. | no | "" |
| required | Whether to fail the job when no files match the `file` glob. Parsed as boolean ("true"/"false"). Defaults to "true". | no | true |
| step-summary | Whether to write the coverage report to GitHub Step Summary. Parsed as boolean ("true"/"false"). Defaults to "true". | no | true |
| title | Heading text used for the coverage section in Step Summary and the `title` output. | no | Coverage |
| thresholds-lines | Line coverage thresholds in "<warn> <fail>" format (e.g. "60 80"). Empty disables the check. | no | "" |
| thresholds-methods | Method coverage thresholds in "<warn> <fail>" format (e.g. "60 80"). Empty disables the check. | no | "" |
| thresholds-conditionals | Conditional/branch coverage thresholds in "<warn> <fail>" format (e.g. "60 80"). Empty disables the check. Skipped when conditional coverage is not measured. | no | "" |
| uncovered-methods-limit | Maximum number of uncovered methods to list in the report. Use "0" or "off" to disable the listing entirely. Defaults to "10". | no | 10 |
Outputs
| name | description |
|---|---|
| title | Heading text used for the coverage report (mirrors the `title` input). |
| lines | Overall line coverage percentage as a number, or "-" if no files were found. |
| methods | Overall method coverage percentage as a number, or "-" if no files were found. |
| conditionals | Overall conditional/branch coverage percentage as a number. Skipped (empty) when conditional coverage is not measured. |
| result | Overall threshold result: "ok", "warn", or "fail". "-" when no files were found. |
| report | Full coverage report serialized as a JSON string. |