unguisai/Doc Pilot Gate
PR documentation gate for README, docs, and changelog updates
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| openai_api_key | OpenAI API key for LLM-powered analysis | yes | — |
| github_token | GitHub token for PR interactions | no | ${{ github.token }} |
| model | OpenAI model to use for analysis | no | gpt-4o-mini |
| doc_paths | Comma-separated list of doc files or directories to check (directories end with /). The built-in default covers README.md, docs/, CHANGELOG.md, and UPGRADING.md, then auto-discovers up to 3 extra top-level doc-rich directories unless you override doc_paths explicitly. | no | "" |
| mode | Operation mode: "report" writes a step summary without PR writes, "suggest" posts a PR comment, and "auto-update" commits changes directly to the PR branch | no | suggest |
| fail_on_impact | Optional quality gate. When set to minor, moderate, or major, the action marks the run failed if the detected documentation impact meets or exceeds that level. | no | "" |
| comment_on_no_impact | Set to "true" to keep all-clear comments when no documentation changes are needed. Default is quiet mode. | no | false |
Outputs
| name | description |
|---|---|
| impact | Overall documentation impact level: none, minor, moderate, or major |
| docs_updated | Number of documentation files that need updates |
| summary | Short summary of the PR changes and documentation impact |