skills.rest
coinbase
coinbaseOFFICIAL
Explore all skills by this author →
WebsiteGitHub

detect-breaking-changes

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

493|101|Updated Nov 8, 2024
Search Tags:#git#typescript#code review#api#breaking changes#semver
One-click install
npx skills add https://github.com/coinbase/cds --skill detect-breaking-changes
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: detect-breaking-changes
Source: https://github.com/coinbase/cds/tree/main/.claude/skills/detect-breaking-changes
Command: npx skills add https://github.com/coinbase/cds --skill detect-breaking-changes

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill identifies and categorizes breaking changes in the codebase across specified packages, helping to prevent regressions and inform consumers of potential impacts.

Core Features & Use Cases

  • Commit Analysis: Reviews a specified number of recent commits to pinpoint breaking changes.
  • API Surface Definition: Accurately determines the public API based on package.json exports and barrel files.
  • Categorization: Classifies breaking changes into predefined categories (Removal, API Change, Type Definition Change, etc.).
  • Use Case: Before merging a large feature, use this Skill to automatically audit the last 10 commits for any unintended breaking changes to the public API, ensuring stability.

Quick Start

Analyze the previous 5 commits for breaking changes in the web and mobile packages.

Frequently Asked Questions about detect-breaking-changes

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

FAQPage Schema
How do I detect breaking API changes in recent Git commits?▼

Detect breaking API changes by analyzing recent Git commits to identify modifications affecting the public API surface. This process inspects package.json exports and follows export chains to pinpoint and categorize breaking changes within specified packages.

What types of breaking changes are identified during code review?▼

Code review identifies breaking changes by categorizing modifications into predefined types such as Removals, API Changes, Type Definition Changes, Visual/Layout Changes, DOM/Element Structure Changes, and Behavioral Changes affecting the public API.

How does the tool determine the public API surface for TypeScript packages?▼

The public API surface for TypeScript packages is determined by inspecting package.json exports and following export chains through barrel files. This accurately defines the boundaries used to detect breaking changes in the codebase.

Can I audit specific packages for unintended breaking changes before merging?▼

You can audit specific packages for unintended breaking changes before merging by specifying the package names and the number of recent commits to review. This prevents regressions and informs consumers of potential impacts.

What is the best way to categorize semver breaking changes in a Git repository?▼

Categorize semver breaking changes by analyzing recent Git commits and classifying modifications into Removals, API Changes, Type Definition Changes, Visual/Layout Changes, DOM/Element Structure Changes, and Behavioral Changes based on the public API surface.

Does this breaking change detection work with visual and DOM structure modifications?▼

Breaking change detection works with visual and DOM structure modifications by categorizing them as Visual/Layout Changes and DOM/Element Structure Changes. It inspects export chains to identify modifications affecting these components alongside API and type changes.

Related Skills

Explore More Software Engineering Skills→
ather-techieather-techie
6

commit-message

Generate standardized git commit messages from staged changes and repository history.

Community
Intermediate
ApiliumCodeApiliumCode
12

changelog-tracker

Monitor software version changes and detect breaking changes via semantic versioning analysis.

Official
Intermediate
GoBeromsuGoBeromsu

verification-validator

Validate code changes with pytest, webpack, or Playwright tests based on change type.

Community
Intermediate
ligianehualigianehua

review

Analyze git diffs for SQL safety, LLM trust boundaries, and structural defects.

Community
Advanced