schema-e2e-validation

Validate YAML schema contracts against live ClickHouse and regenerate Python types, DDL, and docs.

62|10|Updated Dec 4, 2025
One-click install
npx skills add https://github.com/terrylica/cc-skills --skill schema-e2e-validation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: schema-e2e-validation
Source: https://github.com/terrylica/cc-skills/tree/main/plugins/quality-tools/skills/schema-e2e-validation
Command: npx skills add https://github.com/terrylica/cc-skills --skill schema-e2e-validation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires earthly, colima, docker, doppler, brew, and includes scripts (resource) components.

What problem does it solve?

It enables robust end-to-end validation of YAML schema contracts, ensuring schema changes align with live targets and regenerating type definitions, DDL, and docs from YAML.

Core Features & Use Cases

  • Full Validation Pipeline: Validate YAML schemas, regenerate Python types, DDL, and docs.
  • Live Target Testing: Compare contracts against live ClickHouse/Cloud targets.
  • Artifacts & Artifacts Location: Produce artifacts under earthly-artifacts for traceability.

Quick Start

Start required services (e.g., Colima and Docker), then run Earthly targets like +test-schema-e2e or +test-schema-validate as appropriate.

Frequently Asked Questions about schema-e2e-validation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate YAML schema contracts against a live ClickHouse database?

YAML schema validation compares your schema definitions against live ClickHouse or ClickHouse Cloud targets to ensure contracts align. Run the +test-schema-e2e Earthly target after configuring Doppler secrets for your validation target and starting Docker via Colima.

Can I automatically regenerate Python types and DDL from YAML schema changes?

Yes. This Skill regenerates Python type definitions, DDL statements, and documentation directly from YAML schemas. Artifacts are output to earthly-artifacts for traceability whenever schema validation completes.

What do I need to set up before running end-to-end schema validation?

Prerequisites include Earthly, Colima, Docker, Doppler (for secret management), and Homebrew. Start Colima and Docker, configure Doppler credentials for your ClickHouse target, then invoke Earthly build targets like +test-schema-validate or +test-schema-e2e.

When should I run schema validation during my development workflow?

Run validation during pre-commit schema changes to catch contract misalignments early, and before deploying live schema modifications to ClickHouse Cloud. The Skill supports both scenarios through separate Earthly targets.

Does this work with ClickHouse Cloud or only self-hosted ClickHouse?

The Skill validates against both live ClickHouse and ClickHouse Cloud targets. Configure your target endpoint and credentials through Doppler, then the validation pipeline compares your YAML contracts end-to-end.

What happens if my YAML schema doesn't match the live database?

Validation detects schema misalignments and reports failures. You can then update your YAML definitions, regenerate artifacts, and re-run validation to confirm alignment before proceeding with deployments.