chrysa/Guideline Checker
Check project compliance against .github/instructions/ rules. Generates SARIF (GitHub Code Scanning), Markdown, and HTML reports.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| central-api-key | API key sent to the central server as X-Api-Key. Leave empty to skip the push. | no | "" |
| central-server | Base URL of a central guideline server to push the JSON report to. Empty disables the push. | no | "" |
| exclude | Comma-separated globs (relative to root) to skip. A bare directory name excludes everything beneath it. Example: tests, scripts/**, **/*.md | no | "" |
| fail-on | Severity threshold that causes the action to fail. Accepted values: error | warning | never. | no | error |
| instructions | Path to the instructions directory. Defaults to <root>/.github/instructions. | no | "" |
| python-version | Python version used to install and run guideline-checker. | no | 3.14 |
| root | Project root directory (defaults to repository root). | no | ${{ github.workspace }} |
| sarif-output | Path to write the SARIF 2.1.0 report. | no | guideline-results.sarif |
| upload-sarif | Upload SARIF to GitHub Code Scanning (requires security-events write permission). | no | true |
Outputs
| name | description |
|---|---|
| sarif-path | Absolute path to the generated SARIF report. |
| violations | Total number of violations found. |