cicirello/jacoco-badge-generator
JaCoCo coverage badges and pull request coverage checks in GitHub Actions
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 26, 2026
- License
- MIT
Pinned Snippet
uses: cicirello/jacoco-badge-generator@72266185b7ee48a6fd74eaf0238395cc8b14fef8 # v2.12.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| jacoco-csv-file | Full path, relative to the root of the repository, to the jacoco csv file(s), including filename(s) | no | target/site/jacoco/jacoco.csv |
| badges-directory | The directory for storing badges, relative to the root of the repository. | no | .github/badges |
| coverage-badge-filename | The filename of the coverage badge. | no | jacoco.svg |
| branches-badge-filename | The filename of the branches coverage badge. | no | branches.svg |
| generate-coverage-badge | Controls whether or not to generate the coverage badge. | no | true |
| generate-branches-badge | Controls whether or not to generate the branches coverage badge. | no | false |
| coverage-label | Text for the left-side of the coverage badge. | no | coverage |
| branches-label | Text for the left-side of the branches coverage badge. | no | branches |
| on-missing-report | Controls what happens if one or more jacoco.csv files do not exist. | no | fail |
| fail-if-coverage-less-than | Enables failing workflow run when coverage below specified threshold. | no | 0 |
| fail-if-branches-less-than | Enables failing workflow run when branches coverage below specified threshold. | no | 0 |
| fail-on-coverage-decrease | Enables failing workflow if coverage is less than it was on previous run. | no | false |
| fail-on-branches-decrease | Enables failing workflow if branches coverage is less than it was on previous run. | no | false |
| coverage-decrease-limit | Overrides fail-on-coverage-decrease when coverage is at least this limit | no | 100 |
| branches-decrease-limit | Overrides fail-on-branches-decrease when branches coverage is at least this limit | no | 100 |
| intervals | List of coverage percentages as cutoffs for each color. | no | 100 90 80 70 60 0 |
| colors | List of colors to use ordered by coverage interval, best coverage to worst. | no | #4c1 #97ca00 #a4a61d #dfb317 #fe7d37 #e05d44 |
| generate-coverage-endpoint | Controls whether or not to generate the coverage JSON endpoint. | no | false |
| generate-branches-endpoint | Controls whether or not to generate the branches coverage JSON endpoint. | no | false |
| coverage-endpoint-filename | The filename of the coverage JSON endpoint. | no | jacoco.json |
| branches-endpoint-filename | The filename of the branches coverage JSON endpoint. | no | branches.json |
| generate-summary | Controls whether or not to generate a JSON file containing the coverage percentages as floating-point values. | no | false |
| summary-filename | The filename of the summary file. | no | coverage-summary.json |
| generate-workflow-summary | Controls whether or not to append summary to the GitHub workflow summary page. | no | true |
| workflow-summary-heading | The heading for the GitHub workflow job summary | no | JaCoCo Test Coverage Summary |
Outputs
| name | description |
|---|---|
| coverage | The jacoco coverage percentage as computed from the data in the jacoco.csv file. |
| branches | The jacoco branch coverage percentage as computed from the data in the jacoco.csv file. |