systemartis/readmedaddy drift check
Comment, open a dashboard issue, or fail when README-relevant files (manifests, entrypoints, CI, install scripts) changed but the README did not. Handles pull requests, merge queues, pushes to the default branch, and scheduled sweeps. Pure local git — no network calls of its own, no LLM, no data leaves the runner. Configure per-repo with .readmedaddy.json.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| mode | Legacy PR-event fallback when the repo has no guard.pr config: "comment" posts/updates one sticky PR comment; "fail" fails the job. A guard.pr value in the base ref's .readmedaddy.json always wins. | no | comment |
| github-token | Token used only to post PR comments / the dashboard issue. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| drift | "true" if drift was detected, else "false". |
| files | Newline-separated drifted files (empty when fresh). |