breaking-changes

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.

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.

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.

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.

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.

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.