raccioly/DocGuard — CDD Compliance
Audit, guard, and score your project for Canonical-Driven Development compliance.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 7, 2026
- License
- MIT
Pinned Snippet
uses: raccioly/docguard@a41c0ef69bae9db2f9ca065d3ed3842a0f4ea712 # v0.31.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| command | Command to run: audit, guard, score, diff, fix, sync | no | guard |
| format | Output format: text or json | no | text |
| fail-on-warning | Fail the action on warnings (not just errors) | no | false |
| score-threshold | Minimum CDD score to pass (0-100). Only used with score command. | no | 0 |
| working-directory | Project directory to scan | no | . |
| node-version | Node.js version to use | no | 20 |
| annotations | When command=guard: emit inline annotations (::error/::warning) on the PR diff, one per finding, capped at 50. | no | true |
| pr-comment | When command=guard: post a sticky guard-status + doc-impact comment on the PR. Only acts on pull_request events; requires permissions.pull-requests=write (degrades to a log warning without it). Distinct from comment-on-pr, which covers fix/sync summaries. | no | true |
| auto-commit | When command=fix or sync: commit any mechanical fixes back to the PR branch. Requires permissions.contents=write on the calling workflow. | no | false |
| commit-message | Commit message body when auto-commit applies fixes. Trailer co-author is appended automatically. | no | docs: apply DocGuard mechanical fixes |
| comment-on-pr | When command=fix, guard, or sync: post a summary comment on the PR. Requires permissions.pull-requests=write. | no | false |
| bot-name | Git author name for the auto-commit. Defaults to a clearly-marked bot identity. | no | docguard-bot |
| bot-email | Git author email for the auto-commit. | no | docguard-bot@users.noreply.github.com |
Outputs
| name | description |
|---|---|
| score | CDD maturity score (0-100) |
| grade | CDD grade (A+, A, B, C, D, F) |
| result | Full JSON result from DocGuard |
| fixes-applied | For command=fix: number of mechanical fixes applied (0 = none, no commit was made) |
| changed-files | For command=fix or sync: newline-separated list of files modified by --write |
| committed | For auto-commit=true: "true" if a commit was pushed, "false" otherwise |