sjarmak/Livedocs Check
Detect documentation drift in your repository using livedocs check
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | Livedocs version to use (e.g., v0.1.0). Defaults to latest release. | no | latest |
| path | Repository path to check for documentation drift. | no | . |
| format | Output format: text or json. | no | json |
| fail-threshold | Maximum allowed drift score (total stale + stale packages). Set to -1 to never fail. | no | 0 |
| github-token | GitHub token for downloading release assets. Defaults to the workflow token. | no | ${{ github.token }} |
| badge-api-url | Badge endpoint URL (e.g., https://livedocs-badge.example.workers.dev). If set, drift results are POSTed to update the badge. | no | "" |
| badge-api-token | Bearer token for authenticating with the badge API. | no | "" |
Outputs
| name | description |
|---|---|
| drift-score | Total drift score (stale references + stale packages) |
| total-stale | Number of stale symbol references |
| total-stale-packages | Number of stale package paths |
| total-undocumented | Number of undocumented exports (informational) |
| has-drift | Whether structural drift was detected (true/false) |