Infrahub Repo Auditor
Overview
Comprehensive audit of an Infrahub repository against
all rules and best practices from the infrahub-skills
plugin. Produces a structured report covering schemas,
objects, checks, generators, transforms, menus,
.infrahub.yml configuration, and deployment readiness.
Project Context
Project structure:
!find . -maxdepth 2 -type f \( -name "*.yml" -o -name "*.yaml" -o -name "*.py" -o -name "*.gql" -o -name "*.j2" \) 2>/dev/null | head -40
Infrahub config:
!cat .infrahub.yml 2>/dev/null || echo "No .infrahub.yml found"
When to Use
- Before deploying a repository to Infrahub
- When onboarding to an existing Infrahub project
- After significant refactoring to catch regressions
- As a periodic quality gate in development workflows
- When troubleshooting schema loading, object sync,
or pipeline failures
How It Works
When invoked, the auditor:
- Discovers the project structure
(
.infrahub.yml, schemas, objects, checks,
generators, transforms, menus)
- Validates each component against the rules
defined in the infrahub-skills plugin
- Cross-references between components (e.g.,
query names match between Python files and
.infrahub.yml)
- Generates a markdown report with findings organized by severity
Audit Categories
| Priority |
Category |
What It Checks |
| CRITICAL |
Project Structure |
.infrahub.yml exists, paths valid |
| CRITICAL |
Schema Validation |
Naming, relationships, deprecated fields |
| CRITICAL |
Object Validation |
YAML structure, value types, refs |
| CRITICAL |
Python Components |
Class inheritance, required methods |
| HIGH |
Cross-References |
Query names match, target groups |
| HIGH |
Relationships |
Bidirectional IDs, cardinality |
| HIGH |
Registration |
All files registered, no orphans |
| MEDIUM |
Best Practices |
human_friendly_id, display_label |
| MEDIUM |
Deployment |
Git status, bootstrap placement |
| LOW |
Patterns & Style |
Code organization, naming |
Running the Audit
Tell Claude: "Audit this Infrahub repo" or "Run the Infrahub repo auditor"
The auditor will scan the current working directory and produce a report.
Report Format
The report is written to AUDIT_REPORT.md in the project root with this structure:
# Infrahub Repository Audit Report
## Summary
- Total findings: N
- Critical: N | High: N | Medium: N | Low: N | Info: N
## Project Structure
...
## Schema Audit
...
## Object Data Audit
...
## Checks Audit
...
## Generators Audit
...
## Transforms Audit
...
## Menus Audit
...
## Cross-Reference Integrity
...
## Deployment Readiness
...
Audit Rules Reference
The auditor checks rules from all skills:
- ../infrahub-managing-schemas/ -- Naming,
relationships, attributes, hierarchy, display,
extensions, uniqueness, migration
- ../infrahub-managing-objects/ -- Format,
values, children, ranges, organization
- ../infrahub-managing-checks/ --
Architecture, Python class, API, registration
- ../infrahub-managing-generators/ --
Architecture, Python class, tracking, API
- ../infrahub-managing-transforms/ --
Types, Python/Jinja2, hybrid, artifacts, API
- ../infrahub-managing-menus/ -- Format,
item properties, hierarchy, icons
- ../infrahub-common/ -- Git integration,
caching,
.infrahub.yml reference, GraphQL
Rules
See rules/ for detailed audit rule definitions.
1---2name: infrahub-auditing-repo3description: Audits an Infrahub repository against best practices and rules, producing a structured compliance report. TRIGGER when: reviewing repo for compliance, onboarding to existing project, pre-deployment validation, catching issues. DO NOT TRIGGER when: creating schemas, writing checks/generators, querying live data, populating objects.4---56# Infrahub Repo Auditor78## Overview910Comprehensive audit of an Infrahub repository against11all rules and best practices from the infrahub-skills12plugin. Produces a structured report covering schemas,13objects, checks, generators, transforms, menus,14`.infrahub.yml` configuration, and deployment readiness.1516## Project Context1718Project structure:19!`find . -maxdepth 2 -type f \( -name "*.yml" -o -name "*.yaml" -o -name "*.py" -o -name "*.gql" -o -name "*.j2" \) 2>/dev/null | head -40`2021Infrahub config:22!`cat .infrahub.yml 2>/dev/null || echo "No .infrahub.yml found"`2324## When to Use2526- Before deploying a repository to Infrahub27- When onboarding to an existing Infrahub project28- After significant refactoring to catch regressions29- As a periodic quality gate in development workflows30- When troubleshooting schema loading, object sync,31 or pipeline failures3233## How It Works3435When invoked, the auditor:36371. **Discovers** the project structure38 (`.infrahub.yml`, schemas, objects, checks,39 generators, transforms, menus)402. **Validates** each component against the rules41 defined in the infrahub-skills plugin423. **Cross-references** between components (e.g.,43 query names match between Python files and44 `.infrahub.yml`)454. **Generates** a markdown report with findings organized by severity4647## Audit Categories4849| Priority | Category | What It Checks |50| -------- | -------- | -------------- |51| CRITICAL | Project Structure | `.infrahub.yml` exists, paths valid |52| CRITICAL | Schema Validation | Naming, relationships, deprecated fields |53| CRITICAL | Object Validation | YAML structure, value types, refs |54| CRITICAL | Python Components | Class inheritance, required methods |55| HIGH | Cross-References | Query names match, target groups |56| HIGH | Relationships | Bidirectional IDs, cardinality |57| HIGH | Registration | All files registered, no orphans |58| MEDIUM | Best Practices | human_friendly_id, display_label |59| MEDIUM | Deployment | Git status, bootstrap placement |60| LOW | Patterns & Style | Code organization, naming |6162## Running the Audit6364Tell Claude: **"Audit this Infrahub repo"** or **"Run the Infrahub repo auditor"**6566The auditor will scan the current working directory and produce a report.6768## Report Format6970The report is written to `AUDIT_REPORT.md` in the project root with this structure:7172```markdown73# Infrahub Repository Audit Report7475## Summary7677- Total findings: N78- Critical: N | High: N | Medium: N | Low: N | Info: N7980## Project Structure8182...8384## Schema Audit8586...8788## Object Data Audit8990...9192## Checks Audit9394...9596## Generators Audit9798...99100## Transforms Audit101102...103104## Menus Audit105106...107108## Cross-Reference Integrity109110...111112## Deployment Readiness113114...115```116117## Audit Rules Reference118119The auditor checks rules from all skills:120121- **[../infrahub-managing-schemas/](../infrahub-managing-schemas/)** -- Naming,122 relationships, attributes, hierarchy, display,123 extensions, uniqueness, migration124- **[../infrahub-managing-objects/](../infrahub-managing-objects/)** -- Format,125 values, children, ranges, organization126- **[../infrahub-managing-checks/](../infrahub-managing-checks/)** --127 Architecture, Python class, API, registration128- **[../infrahub-managing-generators/](../infrahub-managing-generators/)** --129 Architecture, Python class, tracking, API130- **[../infrahub-managing-transforms/](../infrahub-managing-transforms/)** --131 Types, Python/Jinja2, hybrid, artifacts, API132- **[../infrahub-managing-menus/](../infrahub-managing-menus/)** -- Format,133 item properties, hierarchy, icons134- **[../infrahub-common/](../infrahub-common/)** -- Git integration,135 caching, `.infrahub.yml` reference, GraphQL136137## Rules138139See [rules/](./rules/) for detailed audit rule definitions.
opsmill