systems quality automation

Quality automation

Active contributors: Bryan

Quality automation is part of the product's agent-readiness story. CI, local policy scripts, and repository templates help keep Lode easy for agents to inspect, validate, and change safely.

Directory layout

.github/workflows/ci.yml       # validation pipeline
.github/workflows/codeql.yml   # CodeQL analysis
.github/workflows/pr-review.yml # automated PR readiness comment
scripts/                       # local policy and docs-generation scripts
.pre-commit-config.yaml        # pre-commit hooks

Key abstractions

Name	File	Description
Validate job	.github/workflows/ci.yml	Runs format, lint, type, test, coverage, complexity, dead-code, dependency, security, and policy checks.
CodeQL job	.github/workflows/codeql.yml	Runs GitHub code scanning for Python.
PR readiness comment	.github/workflows/pr-review.yml	Posts a checklist-style review comment.
Policy scripts	scripts/	Enforce repo-specific constraints.
Pre-commit hooks	.pre-commit-config.yaml	Runs local checks before commits.

How it works

CI installs Python 3.13 with uv, syncs dependencies with uv sync --extra kuzu --dev, then runs the same commands listed in AGENTS.md. Policy scripts cover large files, maintenance markers, agent instructions, feature flags, duplicate code, and OpenAPI doc freshness.

Integration points

• AGENTS.md documents the local validation contract for agents.
• .github/pull_request_template.md asks contributors to report validation and risk.
• .github/dependabot.yml and renovate.json handle dependency update policy.

Entry points for modification

Add project-specific checks under scripts/, then wire them into .github/workflows/ci.yml and .pre-commit-config.yaml. Keep scripts fast and deterministic so agents can run them locally.

Key source files

File	Purpose
.github/workflows/ci.yml	Main validation workflow.
.github/workflows/codeql.yml	Code scanning.
.github/workflows/pr-review.yml	Automated PR comment.
.pre-commit-config.yaml	Local hook configuration.
scripts/check_duplicate_code.py	Duplicate-code policy check.
scripts/generate_openapi_docs.py	API docs generator.

Related pages

• Tooling
• Deployment
• Dependency freshness