het2576/Driftless Docs Check
Automatically checks if your README is in sync with your code on every PR or push.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| repo-token | GitHub token for posting PR comments (use ${{ secrets.GITHUB_TOKEN }}) | yes | — |
| driftless-api-key | Your Driftless API key from driftlessx.dev/settings | yes | — |
| fail-on-drift | Set to "true" to fail the CI check when drift score is below threshold | no | false |
| drift-threshold | Drift score (0-100) below which to warn or fail. Default: 70 | no | 70 |
| post-comment | Set to "false" to disable PR comments (warnings still appear in logs) | no | true |
Outputs
| name | description |
|---|---|
| drift-score | The drift score (0-100). 100 = fully in sync. Below 70 = needs attention. |
| status | Drift status: in-sync | minor-drift | moderate-drift | major-drift |
| summary | Human-readable summary of what has changed |