deprecation-and-migration

Manages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to

By addyosmani · 30,447 installs

npx skills add addyosmani/agent-skills --skill deprecation-and-migration

Source repository · Upstream listing

Deprecation and Migration Overview Code is a liability, not an asset. Every line of code has ongoing maintenance cost — bugs to fix, dependencies to update, security patches to apply, and new engineers to onboard. Deprecation is the discipline of removing code that no longer earns its keep, and migration is the process of moving users safely from the old to the new. Most engineering organizations are good at building things. Few are good at removing them. This skill addresses that gap. When to Use Replacing an old system, API, or library with a new one Sunsetting a feature that's no longer needed Consolidating duplicate implementations Removing dead code that nobody owns but everybody depends on Planning the lifecycle of a new system (deprecation planning starts at design time) Deciding whether to maintain a legacy system or invest in migration Core Principles Code Is a Liability Every line of code has ongoing cost: it needs tests, documentation, security patches, dependency updates, and mental overhead for anyone working nearby. The value of code is the functionality it provides, not the code itself. When the same functionality can be provided with less code, less complexity, or better abstractions — the old code should go. Hyrum's Law Makes Removal Hard With enough users, every observable behavior becomes depended on — including bugs, timing quirks, and undocumented side effects. This is why deprecation requires active migration, not just announcement. Users can't "just switch" when they depend on behaviors the replacement doesn't replicate. Deprecation Planning Starts at Design Time When building something new, ask: "How would we remove this in 3 years?" Systems designed with clean interfaces, feature flags, and minimal surface area are easier to deprecate than systems that leak implementation details everywhere. The Deprecation Decision Before deprecating anything, answer these questions: Compulsory vs Advisory Deprecation Type When to Use Mechanism Advisory Migration is optional, old system is stable Warnings, documentation, nudges. Users migrate on their own timeline. Compulsory Old system has security issues, blocks progress, or maintenance cost is unsustainable Hard deadline. Old system will be removed by date X. Provide migration tooling. Default to advisory. Use compulsory only when the maintenance cost or risk justifies forcing migration. Compulsory deprecation requires providing migration tooling, documentation, and support — you can't just announce a deadline. The Migration Process Step 1: Build the Replacement Don't deprecate without a working alternative. The replacement must: Cover all critical use cases of the old system Have documentation and migration guides Be proven in production (not just "theoretically better") Step 2: Announce and Document Step 3: Migrate Incrementally Migrate consumers one at a time, not all at once. For each consumer: The Churn Rule: If you own the infrastructure being deprecated, you are responsible for migrating your users — or providing backward compatible updates that require no migration. Don't announce deprecation and leave users to figure it out. Step 4: Remove the Old System Only after all consumers have migrated: Migration Patterns Strangler Pattern Run old and new systems in parallel. Route traffic incrementally from old to new. When the old system handles 0% of traffic, remove it. Adapter Pattern Create an adapter that translates calls from the old interface to the new implementation. Consumers keep using the old interface while you migrate the backend. Feature Flag Migration Use feature flags to switch consumers from old to new system one at a time: Database Schema Migrations (Expand/Contract) A schema change is the riskiest migration because the data is the one thing you cannot roll back by reverting a deploy. The failure mode is coupling the schema change to the code change: rename a column in the same release that starts using the new name, and during the rollout window — when old and new code run at once — one of them is querying a column that doesn't exist. The fix is to never change a column in place . Migrate in additive phases so old and new code are both valid at every step. Worked example — renaming name to full name : 1. Expand. Add full name as nullable. Deploy. (Old code ignores it; nothing breaks.) 2. Dual write. App writes both name and full name on every insert/update. Deploy. 3. Backfill. Copy name → full name for existing rows, in batches, so you don't lock the table. 4. Switch reads. Point the app at full name , keep writing both. Deploy and bake. 5. Contract. Stop writing name , then — in a separate, later deploy — drop the column. Each step is independently deployable and reversible: if step 4 misbehaves, roll the code back and full name is still being populated. Treat each phase as a thin vertical slice — see the incremental implementation skill. Rules: Additive first, destructive last and alone. Adds (new nullable column, new table, new index) are safe in any deploy; drops and renames get their own deploy after no code references the old shape. Every migration has a tested down path. A migration you can't reverse is a deploy you can't roll back. Write and run the down before merging. Backfill in batches, off the hot path. A single UPDATE over millions of rows locks the table; chunk it and throttle. Build large indexes without blocking writes (e.g. Postgres CREATE INDEX CONCURRENTLY ). Decouple from code by feature flag when the cutover is risky, exactly as in the Feature Flag Migration pattern above. Zombie Code Zombie code is code that nobody owns but everybody depends on. It's not actively maintained, has no clear owner, and accumulates security vulnerabilities and compatibility issues. Signs: No commits in 6+ months but active consumers exist No assigned maintainer or team Failing tests that nobody fixes Dependencies with known vulnerabilities that nobody updates Documentation that references systems that no longer exist Response: Either assign an owner and maintain it properly, or deprecate it with a concrete migration plan. Zombie code cannot stay in limbo — it either gets investment or removal. Common Rationalizations Rationalization Reality "It still works, why remove it?" Working code that nobody maintains accumulates security debt and complexity. Maintenance cost grows silently. "Someone might need it later" If it's needed later, it can be rebuilt. Keeping unused code "just in case" costs more than rebuilding. "The migration is too expensive" Compare migration cost to ongoing maintenance cost over 2 3 years. Migration is usually cheaper long term. "We'll deprecate it after we finish the new system" Deprecation planning starts at design time. By the time the new system is done, you'll have new priorities. Plan now. "Users will migrate on their own" They won't. Provide tooling, documentation, and incentives — or do the migration yourself (the Churn Rule). "We can maintain both systems indefinitely" Two systems doing the same thing is double the maintenance, testing, documentation, and onboarding cost. "Just rename the column, it's one line" During the rollout, old and new code run together — one will query a column that no longer exists. Expand/contract, never rename in place. "I'll add the column and drop the old one in the same migration" That couples a safe add to a destructive drop. Drops get their own deploy, after no code references the old shape. "We'll write the rollback if we need it" A migration with no down path is a deploy you can't reverse. Write and run the down before merging. Red Flags Deprecated systems with no replacement available Deprecation announcements with no migration tooling or documentation "Soft" deprecation that's been advisory for years with no progress Zombie code with no owner and active consumers New features added to a deprecated system (invest in the replacement instead) Deprecation without measuring current usage Removing code without verifying zero active consumers A schema change and the code that depends on it shipped in the same deploy A column renamed or dropped in place rather than via expand/contract A migration merged with no tested down path, or a backfill that locks the table Verification After completing a deprecation: [ ] Replacement is production proven and covers all critical use cases [ ] Migration guide exists with concrete steps and examples [ ] All active consumers have been migrated (verified by metrics/logs) [ ] Old code, tests, documentation, and configuration are fully removed [ ] No references to the deprecated system remain in the codebase [ ] Deprecation notices are removed (they served their purpose) After a database schema migration: [ ] The change ships in additive phases (expand → backfill → contract), not a single in place edit [ ] Old and new code are both valid against the schema at every deploy step [ ] Each migration has a tested down path; backfills run in throttled batches [ ] Destructive steps (drop/rename) ship in their own deploy after no code references the old shape