migration-planning

Plans staged schema, data, API, and configuration migrations with validation and rollback.

73|7|Updated May 26, 2026
One-click install
npx skills add https://github.com/franklioxygen/agent-workflows --skill migration-planning-franklioxygen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: migration-planning
Source: https://github.com/franklioxygen/agent-workflows/tree/main/zh-cn/skills/migration-planning
Command: npx skills add https://github.com/franklioxygen/agent-workflows --skill migration-planning-franklioxygen

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you design safe, backward-compatible migrations for schemas, data, APIs, contracts, and configuration changes while minimizing downtime and rollback risk.

Core Features & Use Cases

  • Migration planning across phases: Break changes into Prepare, Backfill, Switch, and Contract with clear responsibilities and sequencing.
  • Compatibility and rollback strategy: Define how new/old code and new/old data interact, including reversible vs non-reversible steps.
  • Validation, monitoring, and observability: Add data verification queries, acceptance checks, and alert signals tied to each phase.
  • Expand-contract guidance for public interfaces: Use expand-contract patterns to keep contracts stable until safety is proven.

Quick Start

Ask Codex to produce a staged migration plan for a breaking API change and the required database backfill, including verification queries, rollback steps, deployment order, and the exact conditions for removing compatibility code.

Frequently Asked Questions about migration-planning

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

FAQPage Schema
How do I plan a safe database migration with zero downtime and rollback support?

Plan safe migrations by breaking schema changes into Prepare, Backfill, Switch, and Contract phases, defining reversible steps, data verification queries, and explicit rollback ordering to minimize downtime.

What is the expand-contract pattern for breaking API changes?

The expand-contract pattern keeps API contracts stable by adding new fields or endpoints alongside old ones, removing legacy compatibility only after monitoring proves the new contract is safely adopted.

How do I sequence deployments for backward and forward compatibility?

Deployment sequencing coordinates staged changes across code and data, ensuring new code reads old data and old code reads new data, with feature flags and validation checks gating each phase transition.

When should I remove legacy compatibility code after a schema change?

Remove legacy compatibility code only after proof of safety, specifically when monitoring and alert signals confirm all traffic uses the new contract and no rollback to the old schema is anticipated.

How do I backfill existing data during a database migration?

Database backfill during migration involves writing data to both old and new schemas simultaneously, running background jobs to update historical records, and adding validation checks to verify data consistency before the final switch.