breaking-changes

Detect breaking changes between two git refs and generate migration steps.

11|Updated Apr 16, 2026

Search Tags:#versioning #codebase #migration #release-management #breaking-changes #git-diffs #api-changes

Ready to run

npx skills add https://github.com/berkcangumusisik/claude-code-practices --skill breaking-changes-berkcangumusisik

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: breaking-changes
Source: https://github.com/berkcangumusisik/claude-code-practices/tree/main/skills/breaking-changes
Command: npx skills add https://github.com/berkcangumusisik/claude-code-practices --skill breaking-changes-berkcangumusisik

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detects breaking changes between two git refs and generates a migration guide to help teams adapt code and data models across releases.

Core Features & Use Cases

Detects removed exports, changed function signatures, renamed identifiers, and updated config or behavior between base and head refs.
Generates actionable migration steps to update downstream clients and integration points.
Use Case: When releasing a new version, generate a migration plan that communicates API and schema changes to consumers.

Quick Start

Run the breaking-changes tool to compare the base and head refs and generate a migration guide.

Frequently Asked Questions about breaking-changes

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

FAQPage Schema

How do I detect breaking changes between two git refs for a new release?▼

Detecting breaking changes involves comparing a base and head git ref to identify removed exports, changed signatures, and updated configuration, then generating a migration guide with actionable steps for downstream consumers.

What is a breaking changes migration guide and when do I need one?▼

A breaking changes migration guide documents removed exports, changed signatures, and updated config between versioned releases. You need one when releasing new versions of codebases with public APIs or database schemas to coordinate team-wide updates.

Can I generate migration steps for database schema changes across versioned releases?▼

Yes, you can generate migration steps for database schema changes. The tool compares git refs to detect renamed resources and changed behavior, enabling team-wide coordination of data model updates across versioned releases.

What's the best way to document API changes for downstream consumers?▼

The best way to document API changes is to compare git refs to detect removed exports and changed function signatures, then generate an actionable migration plan communicating required updates to downstream integration points.

Does this breaking changes tool work with codebases that have public APIs?▼

Yes, this tool works with codebases that have public APIs. It compares versioned releases to detect removed exports, changed signatures, and updated behavior, then outputs concrete migration steps for your team.

Why should I not use manual git diffs for tracking breaking changes in release management?▼

Manual git diffs are insufficient for release management because they only show raw code differences without identifying semantic breaking changes like changed function signatures or removed exports, nor do they generate actionable migration steps.