Add one step to a workflow and your README carries a live score badge. 16 fixed checks, no signup, no API key, no third-party service in the loop — the action is the audit.
name: site audit
on: [push, workflow_dispatch]
permissions:
contents: write
jobs:
audit:
runs-on: ubuntu-latest
steps:
- uses: kevindurant735rocket-creator/ks-audit-bot@v1
with:
url: https://your-site.com
That is the whole install. On every run it writes
.github/ks-audit-badge.svg and updates a marked block in your
README in place, so the number is never stale and never copy-pasted.
| Output | Meaning |
|---|---|
score | Weighted score out of 100 |
grade | Letter grade A to F |
failed | How many of the 16 checks failed |
Use them to gate on your own threshold, not ours:
- id: audit
uses: kevindurant735rocket-creator/ks-audit-bot@v1
with:
url: https://your-site.com
- if: steps.audit.outputs.score < 80
run: echo "site scored ${{ steps.audit.outputs.score }}, fix the report"
A low score is a result, not an error. The step never fails your build because your site scored badly — otherwise nobody would leave it on.
Every check is a fixed rule with a fixed weight. No model, no sampling, so an unchanged site returns the same number on a rerun. Each one is documented with the command to see it yourself and the config that fixes it: