sandwichfarm/AI Slop Badge
Run aislop, generate a Shields endpoint badge JSON file, and optionally commit it.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| scan-path | Path to scan. | no | . |
| aislop-version | aislop npm package version to run. Pin this in your workflow for a deterministic badge — if you rely on this default, your badge score can change whenever this default is bumped or (if set to a range) whenever a new aislop is published, and it may differ from the version you run locally. | no | 0.12.0 |
| package-runner | Package runner used to execute aislop. Supported values are npx, pnpm, and bunx. | no | npx |
| badge-file | Path where the Shields endpoint JSON badge source should be written. | no | .github/badges/aislop-score.json |
| badge-label | Label shown on the badge. | no | ai slop |
| badge-message-template | Badge message template. Supported tokens are {score}, {label}, {errors}, {warnings}, and {fixable}. | no | {score}/100 {label} |
| badge-color | Badge color override. Leave empty to choose a color from the score. | no | "" |
| minimum-score | Minimum acceptable score. Use 0 to disable the score threshold. | no | 0 |
| fail-on-error | Fail the action when the aislop scan exits non-zero. | no | true |
| commit-badge | Commit the badge file when it changes. | no | false |
| push | Push the badge commit after committing. Used only when commit-badge is true. | no | true |
| commit-message | Commit message used when commit-badge is true. | no | chore: update AI slop score badge [skip ci] |
| git-user-name | Git author name used when commit-badge is true. | no | github-actions[bot] |
| git-user-email | Git author email used when commit-badge is true. | no | 41898282+github-actions[bot]@users.noreply.github.com |
| summary | Write a concise Markdown summary to the workflow run. | no | true |
Outputs
| name | description |
|---|---|
| score | Numeric aislop score. |
| label | aislop score label. |
| color | Badge color. |
| errors | Number of aislop errors. |
| warnings | Number of aislop warnings. |
| fixable | Number of fixable aislop issues. |
| report-file | Path to the raw aislop JSON report. |
| badge-file | Path to the generated badge JSON file. |
| exit-code | Exit code returned by the aislop scan. |
| meets-minimum | Whether the score meets minimum-score. |
| badge-updated | Whether this action committed a badge file update. |
| commit-sha | Commit SHA created by this action, when commit-badge is true and a commit was needed. |