deprecation-and-migration

Plan and execute staged removal of deprecated TypeScript APIs with semver-aligned migrations.

18|1|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/nexus-substrate/nexus-agents --skill deprecation-and-migration-nexus-substrate
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: deprecation-and-migration
Source: https://github.com/nexus-substrate/nexus-agents/tree/main/skills/deprecation-and-migration
Command: npx skills add https://github.com/nexus-substrate/nexus-agents --skill deprecation-and-migration-nexus-substrate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams remove deprecated APIs while preserving consumer compatibility by turning risky deletions into a staged, well-documented migration plan with clear semver guidance and verification steps.

Core Features & Use Cases

  • Pre-removal governance checklist: validates bake duration, canonical replacements, migration recipes, reachability, and the correct semver target before any cleanup PR is opened.
  • Blast-radius batch decomposition: splits removals into isolated batches (internal-only, typed unions, public type aliases, runtime API changes) so failures are easier to triage and revert.
  • Implementation + migration verification loop: runs typecheck/lint/test, updates call sites, sweeps documentation references, creates changesets with actionable diffs, and includes QA via consensus voting.
  • Post-merge operational validation: verifies the published npm version matches the intended changeset version and closes the epic only after the artifact is live.

Quick Start

Use the deprecation-and-migration skill to plan and execute the removal of a deprecated API by batching the change, producing a complete migration diff, running tests, and generating a semver changeset that documents the correct upgrade path.

Frequently Asked Questions about deprecation-and-migration

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

FAQPage Schema
How do I safely remove deprecated APIs without breaking TypeScript consumers?▼

Removing deprecated APIs safely requires batching the cleanup by blast radius and applying semver-aligned migrations for consumers. This process uses a pre-removal checklist to validate bake duration and replacements before staging isolated removals.

What is the best way to plan a breaking changes migration for a deprecated API?▼

Planning breaking changes migrations involves inventorying affected surfaces and decomposing removals into batches like internal-only changes and runtime API updates. You then create changesets with concrete diff-based migration recipes to verify the update path.

How do I manage string-union member removals and type alias deletions in TypeScript?▼

Managing string-union member removals and type alias deletions involves isolating these typed changes into specific blast-radius batches. You run typecheck and lint validation across the batch to catch consumer type errors before generating a semver changeset.

Does this approach to API deprecation require changesets for npm package publishing?▼

Yes, API deprecation retirement requires changesets for npm package publishing to document the correct semver upgrade path. Post-merge operational validation verifies that the published npm version matches the intended changeset version before closing the epic.

Can I use this deprecation retirement workflow for documentation references and public symbol renames?▼

Yes, this deprecation retirement workflow handles public symbol renames and documentation references by sweeping docs during the migration verification loop. The process fits deprecation retirement work involving @deprecated markers across TypeScript and documentation.

When should I batch API deprecation removals instead of deleting them all at once?▼

You should batch API deprecation removals when handling mixed blast radius scopes like internal-only changes alongside runtime API changes. Splitting removals into isolated batches ensures failures are easier to triage and revert during the migration verification loop.