bloodf/CI Badges Action
Generate version, build, tests, and coverage SVG badges and optionally commit them.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| output-dir | Directory where badge SVG files are written. | no | badges |
| coverage-summary-path | Path to Istanbul/Vitest coverage-summary.json. | no | coverage/coverage-summary.json |
| package-json-path | Path to package.json used for the version badge. | no | package.json |
| version | Explicit version badge value. Defaults to package.json version. | no | "" |
| build-status | Build status value, usually steps.<build-step>.outcome. | no | success |
| tests-status | Tests status value, usually steps.<test-step>.outcome. | no | success |
| commit | Commit changed badge files back to the checked-out branch. | no | false |
| commit-message | Commit message used when commit=true. | no | chore: update status badges [skip ci] |
| git-user-name | Git author name used when commit=true. | no | github-actions[bot] |
| git-user-email | Git author email used when commit=true. | no | 41898282+github-actions[bot]@users.noreply.github.com |
Outputs
| name | description |
|---|---|
| version-badge | Path to the generated version badge. |
| build-badge | Path to the generated build badge. |
| tests-badge | Path to the generated tests badge. |
| coverage-badge | Path to the generated coverage badge. |
| committed | Whether badge changes were committed. |