flatbread-major-migration

Coordinate schema-breaking Flatbread monorepo changes with validated migration workflows.

64|2|Updated Nov 8, 2021
One-click install
npx skills add https://github.com/FlatbreadLabs/flatbread --skill flatbread-major-migration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: flatbread-major-migration
Source: https://github.com/FlatbreadLabs/flatbread/tree/main/.cursor/skills/flatbread-major-migration
Command: npx skills add https://github.com/FlatbreadLabs/flatbread --skill flatbread-major-migration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the risk of uncoordinated, breaking changes to the Flatbread monorepo that can break user content models, generated TypeScript types, GraphQL artifacts, and application behavior for teams relying on Flatbread's stable contracts.

Core Features & Use Cases

  • Structured migration workflow: Guides maintainers through read-only diagnosis, contract planning, implementation, and validation for all schema-breaking or developer-contract changes.
  • Monorepo coordination: Aligns changes across core schema generation, resolvers, codegen, CLI, examples, docs, and source/transformer packages to avoid version mismatches.
  • Use case: Use when modifying Flatbread's ID systems, relation refs, filters, root query names, config shape, or CLI behavior to ensure safe, coordinated releases with clear rollback paths.

Quick Start

Use the flatbread-major-migration skill to plan and execute a breaking change to Flatbread's relation ref filtering behavior across core, codegen, and example apps.

Frequently Asked Questions about flatbread-major-migration

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

FAQPage Schema
How do I safely execute schema-breaking migrations in a TypeScript monorepo?

Schema-breaking migrations in a TypeScript monorepo require a structured workflow with read-only diagnosis, contract planning, implementation, and validation to prevent breaking generated types. This coordinates DAG tasks and release gates across all packages to ensure safe, aligned deployments with rollback paths.

What happens to generated GraphQL codegen types when changing core schema generation?

Changing core schema generation breaks generated GraphQL codegen types if uncoordinated across the monorepo. A validated migration workflow aligns resolver arguments, schema artifacts, and TypeScript types to prevent version mismatches and maintain stable developer contracts during release.

When do I need a structured migration workflow for modifying CLI behavior and config shape?

You need a structured migration workflow for modifying CLI behavior and config shape when those changes alter public or generated user-facing contracts. It provides release gates, DAG task coordination, and rollback paths to ensure safe coordinated releases across all affected packages.

Can I update relation ref filters and root query names without breaking user content models?

Updating relation ref filters and root query names without breaking user content models requires coordinating changes across core schema generation, resolvers, codegen, and examples. A structured migration workflow validates these shifts to preserve stable contracts and prevent application behavior failures.

What is the best way to coordinate breaking changes across Flatbread packages?

The best way to coordinate breaking changes across Flatbread packages is a structured migration workflow applying read-only diagnosis, contract planning, implementation, and validation. This aligns core schema, resolvers, CLI, docs, and source transformers to avoid version mismatches and enable clear rollback paths.

Why does uncoordinated schema migration break application behavior in monorepos?

Uncoordinated schema migration breaks application behavior in monorepos because modifying core schema generation, resolver arguments, or config shape without release gates creates version mismatches across generated TypeScript types and user content models. Coordinated DAG task validation prevents these cascading contract failures.