skills.rest
tylerbutler
tylerbutlerCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

review-api-changes

Validate Fluid Framework API reports, export tiers, and backward compatibility.

Updated Jan 7, 2026
Search Tags:#code quality#typescript#ci/cd#backward compatibility#api review#api-extractor
One-click install
npx skills add https://github.com/tylerbutler/repo-overlays --skill review-api-changes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-api-changes
Source: https://github.com/tylerbutler/repo-overlays/tree/main/tylerbutler/FluidFramework/jikim-superskills/.claude/skills/review-api-changes
Command: npx skills add https://github.com/tylerbutler/repo-overlays --skill review-api-changes

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that changes to a project's public API surface are correctly validated, maintaining backward compatibility and adherence to defined export tiers.

Core Features & Use Cases

  • API Report Validation: Verifies that generated API reports are up-to-date and accurate.
  • Export Tier Enforcement: Checks that new and modified APIs are assigned to the appropriate stability tier (public, beta, alpha).
  • Backward Compatibility Testing: Runs type validation and export checks to catch potential breaking changes.
  • Use Case: When a pull request introduces new features or modifies existing ones in a library, this Skill can be used to automatically review the impact on the public API before merging.

Quick Start

Use the review-api-changes skill to validate the API changes in the current pull request.

Frequently Asked Questions about review-api-changes

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

FAQPage Schema
How do I validate API changes for backward compatibility in a pull request?▼

To review API changes, run command-line checks that validate generated API reports, enforce export tier assignments, and test backward compatibility to catch breaking changes before merging.

What is API report validation and when do I need it?▼

API report validation verifies that generated API reports are up-to-date and accurate. You need it when pull requests modify public, beta, or alpha APIs or add new exports to a library.

How do I enforce export tiers for new TypeScript APIs?▼

You enforce export tiers by running checks that verify new and modified APIs are assigned to the appropriate stability tier—public, beta, or alpha—during the API review process.

Does API Extractor work with CI/CD pipelines to catch breaking API changes?▼

Yes, API Extractor works with CI/CD pipelines by running command-line checks on API reports to validate backward compatibility and export tiers, catching breaking changes before merge.

What are the limitations of automated API review for beta and alpha exports?▼

Automated API review validates API reports, export tiers, and backward compatibility through command-line checks, but it applies specifically to API Extractor reports and does not replace manual API design review.

Related Skills

Explore More Software Engineering Skills→
tylerbutlertylerbutler

api-reports

Regenerate API Extractor reports and manage release tags in a monorepo.

Community
Advanced
SjdjdiejdrirhdkjejSjdjdiejdrirhdkjej

breaking-change-detector

Detect breaking API, schema, and interface changes before implementation.

Community
Advanced
Kushal9889Kushal9889

husky

Sets up Husky git hooks to automate code quality checks and testing before commits.

Community
Intermediate
coinbasecoinbase
493

detect-breaking-changes

Analyze recent Git commits to categorize breaking changes in public API surfaces.

Official
Advanced