public-api-compatibility-review

Analyze public API changes to identify breaking compatibility issues.

Updated Apr 30, 2026

Search Tags:#versioning #api #compatibility #migration #library #sdk

Ready to run

npx skills add https://github.com/erikalira/canonkit --skill public-api-compatibility-review

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: public-api-compatibility-review
Source: https://github.com/erikalira/canonkit/tree/main/.codex/skills/public-api-compatibility-review
Command: npx skills add https://github.com/erikalira/canonkit --skill public-api-compatibility-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers evaluate the impact of code changes on public API stability, ensuring compatibility and smooth migration paths.

Core Features & Use Cases

API Compatibility Analysis: Reviews modifications in exported functions, types, and modules for potential breaking changes.
Versioning and Migration Help: Provides recommendations for safe version bumps and migration guidance based on API differences.
Use Case: When upgrading a library, use this Skill to identify breaking changes and generate migration notes to minimize integration issues.

Quick Start

Use the public-api-compatibility-review skill to evaluate the latest library release for compatibility risks.

Frequently Asked Questions about public-api-compatibility-review

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

FAQPage Schema

How do I check for breaking API changes when upgrading a library?▼

Checking for breaking API changes during a library upgrade involves analyzing modifications in exported functions, types, and modules. This Skill reviews those modifications to identify potential compatibility issues and ensure consumer safety.

What is API compatibility analysis and when do I need it?▼

API compatibility analysis evaluates the impact of code changes on public API stability. You need it when updating dependencies or releasing new SDK versions to ensure seamless transitions and minimize integration issues for consumers.

Can I generate migration notes for a library version bump?▼

Yes, you can generate migration guidance for a library version bump. This Skill analyzes API differences between versions to provide recommendations for safe versioning and migration paths.

Does this API compatibility review work with any SDK or library?▼

Yes, this API compatibility review applies to software projects updating any library or SDK dependencies. It requires reading review checklists and specification documents to determine compatibility risks across your codebase.

What is the best way to assess public API stability before a release?▼

The best way to assess public API stability before a release is to analyze changes in exported functions and types for breaking modifications. This Skill evaluates those changes against review checklists to identify compatibility risks.

What are the limitations of automated API compatibility checking?▼

Automated API compatibility checking requires reading review checklists and specification documents to determine risks. It is limited to analyzing exported functions, types, and modules, meaning internal private API changes are not evaluated for consumer safety.