kcemate/Ratchet Code Quality Scan
Scan your codebase with Ratchet and get a production readiness score. Optionally fail the build if score is below threshold.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| threshold | Minimum total score required (0–100). Fails the action if the score is below this value. | no | "" |
| category-thresholds | Comma-separated category minimums in "Category=Score" format, e.g. "Security=12,Testing=20". Each listed category gates independently. | no | "" |
| explain | Pass --explain to include human-readable why/fix explanations per subcategory in the scan output. | no | false |
| working-directory | Directory to scan, relative to the repository root. | no | . |
| version | ratchet-run version to install. Accepts 'latest' or any published semver tag (e.g. '1.0.8'). | no | latest |
| baseline | Path to a previous ratchet-scan.json for delta comparison. When provided, the PR comment shows score change (e.g. +3 pts). | no | "" |
Outputs
| name | description |
|---|---|
| score | The overall ratchet score (0–100). |
| score-delta | Score change vs baseline (e.g. +3, -1, 0). Empty when no baseline is provided. |
| json | Absolute path to the ratchet-scan.json output file. |
| badge-url | shields.io badge URL for embedding the current score in a README. |
| pr-comment-id | GitHub comment ID of the posted PR score card (empty when not in a PR context). |