gha audit
Overview
Checks repositories for compliance issues such as missing descriptions, misconfigured settings, or policy violations. Returns a non-zero exit code when issues are found, making it suitable for CI pipelines.
Usage
python -m src.cli audit [OPTIONS]
Options
| Option | Description | Default |
|---|---|---|
-u, --user USERNAME | GitHub username | -- |
-o, --org NAME | Organization name | -- |
--check {descriptions} | Type of compliance check | descriptions |
--format {console,json} | Output format | console |
Prerequisites
- Repo: github-automator
- Install:
pip install -r requirements.txtfrom repo root - Environment:
GITHUB_TOKENor account-specific tokens
Examples
Audit all repos in an organization
python -m src.cli audit --org symphonycore-org
Audit and export results as JSON
python -m src.cli audit --org symphonycore-org --format json
Exit Codes
| Code | Meaning |
|---|---|
0 | No issues found |
1 | Issues found or operation failed |