How does it help with database migrations?

It compares SQL schemas and migration files to identify table drops, column removals, or narrowing type changes that break backward compatibility.

Does it provide documentation for affected users?

Yes, it automatically generates structured migration guides and reports that include before/after code examples and step-by-step upgrade instructions.

What types of APIs can this skill analyze?

The skill supports OpenAPI (REST), GraphQL, and gRPC/Protobuf specifications to detect schema modifications, endpoint removals, and type changes.

Can I integrate this into my existing CI/CD pipeline?

Yes, the skill includes ready-to-use templates for GitHub Actions and GitLab CI to automatically fail builds if undocumented breaking changes are detected.

Breaking Change Detection

Name: Breaking Change Detection
Author: vanman2024

byvanman2024

Desarrollo de API

Identifies and documents backward-incompatible changes across APIs, databases, and code contracts to ensure stable versioning and smooth migrations.

Acerca de

The Breaking Change Detection skill provides a robust framework for developers to analyze, detect, and mitigate breaking changes during the software development lifecycle. By comparing OpenAPI specifications, GraphQL schemas, database structures, and library contracts, it automates the identification of removals, renames, and type changes that could impact downstream consumers. This skill helps engineering teams maintain backward compatibility, generate accurate migration guides, and integrate automated safety checks directly into CI/CD pipelines, ensuring that every version bump is justified and well-documented.

Características Principales

Automated generation of migration guides and breaking change reports
Severity-based change classification from Critical to Low impact
Comprehensive database schema comparison for SQL and migrations
Automated OpenAPI and GraphQL schema diffing and classification
0 GitHub stars
CI/CD integration templates for automated pull request validation

Casos de Uso

Validating API changes before performing a major version bump
Enforcing backward compatibility checks in automated CI/CD pipelines
Generating user-facing migration guides for breaking software releases

Acerca de

Características Principales

Automated generation of migration guides and breaking change reports
Severity-based change classification from Critical to Low impact
Comprehensive database schema comparison for SQL and migrations
Automated OpenAPI and GraphQL schema diffing and classification
0 GitHub stars
CI/CD integration templates for automated pull request validation

Casos de Uso

Validating API changes before performing a major version bump
Enforcing backward compatibility checks in automated CI/CD pipelines
Generating user-facing migration guides for breaking software releases