ernanej/badge-generator
Generate and save custom Shields.io badges directly from your GitHub Actions workflow.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| name | The right-hand side value of the badge (e.g. "98.7%"). | yes | — |
| prefix | The left-hand label of the badge (e.g. "coverage"). Optional. | no | "" |
| icon | Optional logo icon from Shields.io (e.g. "jest", "github", "npm"). | no | "" |
| color | The background color of the badge (e.g. "green", "blue", "#ffaa00"). | no | blue |
| style | Badge style (flat, flat-square, plastic, for-the-badge, social). | no | flat |
| path | Output file path for the generated badge SVG (e.g. "badges/coverage.svg"). | yes | — |
| labelColor | Optional background color for the left-side label (e.g. "#333"). | no | "" |
| logoColor | Optional color for the logo icon (e.g. "white", "#ffcc00"). | no | "" |
| link | Optional URL or comma-separated URLs to make the badge clickable. | no | "" |
| cacheSeconds | Optional Shields.io cache duration in seconds. | no | "" |
| badge_branch | The branch where the badge should be committed (e.g. badge-generator). | no | badge-generator |
| main_branch | The default branch of the repository (e.g. main). | no | main |
| github_token | GitHub token to post comments on pull requests. | no | "" |
| comment_title | Optional custom title for the pull request comment (e.g. "Vitest Coverage Result"). | no | "" |
Outputs
no outputs