update-examples

Regenerate JSON schema artifacts, examples, and hashes after Zod source changes.

1|Updated Apr 17, 2025
One-click install
npx skills add https://github.com/carrot-foundation/schemas --skill update-examples
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-examples
Source: https://github.com/carrot-foundation/schemas/tree/main/.cursor/skills/update-examples
Command: npx skills add https://github.com/carrot-foundation/schemas --skill update-examples

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Regenerate all JSON schema artifacts, examples, and hashes after modifying Zod source schemas.

Core Features & Use Cases

  • Orchestrates the full regeneration pipeline, ensuring schemas, examples, and hashes stay in sync
  • Executes build, schema generation, hashing, example updates, and validations in the correct order
  • Detects and reports failures early to prevent inconsistent artifacts

Quick Start

Regenerate all artifacts by running the full regeneration pipeline after Zod source changes.

Frequently Asked Questions about update-examples

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

FAQPage Schema
How do I regenerate JSON schema artifacts after modifying Zod source schemas?

To regenerate JSON schema artifacts after modifying Zod source schemas, run the full regeneration pipeline. This orchestrates build, schema generation, hashing, example updates, and validation steps sequentially to keep all artifacts synchronized.

Why are my JSON schema examples out of sync with my Zod schemas?

JSON schema examples fall out of sync with Zod schemas when source changes are made without running the full regeneration pipeline. Executing the update-examples step regenerates examples, hashes, and schemas to restore consistency across all artifacts.

What is the best way to validate regenerated JSON schemas and examples?

The best way to validate regenerated JSON schemas and examples is to run the complete pipeline. It automatically executes validate-schemas and validate-examples steps after generation, ensuring all hashes and references are correct and consistent.

What happens if a step in the schema regeneration pipeline fails?

If a step in the schema regeneration pipeline fails, the process halts to prevent inconsistent artifacts. It detects failures early and provides clear guidance to remediate the issue so you can fix the problem and re-run the pipeline.

When do I need to run the full schema artifact regeneration pipeline?

You need to run the full schema artifact regeneration pipeline whenever you modify Zod source schemas. This ensures that all downstream JSON schema artifacts, examples, and hashes are rebuilt and validated against the updated source definitions.

Does the regeneration pipeline verify schema versions and check references?

Yes, the regeneration pipeline includes verify-schema-versions and check-refs steps. These steps run alongside build, generation, and validation to ensure all schema versions are correct and internal references are intact across the artifacts.