Détecter les changements cassants dans l'API CDS

VérifiéSûr

Analyse les derniers N commits pour détecter les changements cassants dans la surface d'API publique CDS.

Spar Skills Guide Bot
DeveloppementAvancé
24/07/2026
Claude Code
#git#breaking-changes#api-compatibility#monorepo#code-review

Recommandé pour

Synthèse automatique

Analyse les N derniers commits pour détecter les ruptures de compatibilité dans la surface d'API publique des paquets web, mobile et common du monorepo CDS.

Points forts

  • Détermine la surface publique réelle en suivant la chaîne package.json exports → barrel index.ts → modules réexportés
  • Classe chaque rupture selon six catégories explicites (suppression, signature, types, visuel, DOM, comportement)
  • Limite le périmètre aux trois paquets concernés via des commandes git ciblées par chemin
  • Fournit des exemples concrets par catégorie, ce qui réduit les faux positifs

Limites

  • Suppose une convention de monorepo ESM avec cartes exports et barrel files, non vérifiée pour d'autres dépôts
  • Dépend de l'historique git local et de HEAD comme point de référence, sans gestion des branches ou tags de release
  • Les changements visuels et comportementaux restent par nature des jugements sujets à débat
Quand l'utiliser

À utiliser avant une publication ou une revue de release pour savoir si les commits récents cassent des consommateurs de l'API publique.

Quand l'éviter

Ne pas l'utiliser pour vérifier du code hors des paquets web, mobile et common, ni pour des audits de sécurité ou de performance.

Analyse de sécurité

Sûr
Score qualité92/100

The skill uses only read-only Git commands (git log, show, diff, rev-parse) and file inspection tools (Read, Glob, Grep). No destructive, exfiltrating, or network operations are instructed. The declared allowed tools are tightly scoped and non-mutating.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Review last 10 commits
Analyze the last 10 commits for breaking changes in the CDS public API surface.
Pre-release check
Before I publish, check the previous 25 commits in packages/web and packages/mobile for breaking changes to exports, props, and types.
Visual regressions too
Review the last 5 commits and tell me if any default spacing or DOM structure changes in packages/web would break consumer styling.

name: git.detect-breaking-changes description: Analyzes the previous N commits for breaking changes across the CDS public API surface. Use this skill when you need to check if any recent changes will cause breaking changes in the CDS public API surface. allowed-tools: Bash(git log:), Bash(git show:), Bash(git diff:), Bash(git rev-parse:), Read, Glob, Grep argument-hint: [Number of commits to review] model: opus

Your task

Analyze the previous $ARGUMENTS commits for breaking changes across the CDS public API surface.

Scope

Only analyze changes within these packages:

  • packages/web/
  • packages/mobile/
  • packages/common/

Determining the public API surface

Each package is fully ESM. Inspect each package's package.json "exports" map to determine the public entry points. Every symbol (component, function, hook, constant, type, interface, enum) that is reachable through these export paths is part of the public API and subject to breaking change analysis.

Follow the export chain: package.json exports -> entry index.ts barrel file -> re-exported modules. Any symbol that a consumer could import via the package's published entry points is in scope.

How to analyze

  1. Use git log --oneline -$ARGUMENTS -- <package-path> for each package to identify relevant commits.
  2. Use git diff HEAD~$ARGUMENTS..HEAD -- <package-path> and git show <sha> to inspect the actual changes.
  3. For each changed file, determine if it is reachable from a public export path. If not, skip it.
  4. For files that are part of the public API, classify each change using the categories below.

Breaking change categories

1. Removal

A previously exported symbol (component, function, hook, type, interface, constant, enum) has been deleted or is no longer exported.

Examples:

  • A component is removed from the barrel export
  • A named export is deleted
  • A type or interface is no longer re-exported

2. API change (props / function signature)

The call signature of a public function, hook, or component has changed in a way that would break existing consumers.

Examples:

  • A required prop is added to a component
  • A prop is renamed
  • A prop's accepted values are narrowed (e.g., union type member removed)
  • A function parameter is removed, reordered, or made required
  • A hook's return type changes shape
  • Default values are removed or changed in a way that alters behavior

3. Type definition change

A publicly exported type, interface, or enum has been modified in a way that would cause consumer TypeScript compilation to fail.

Examples:

  • A property is removed from an exported interface
  • A type union is narrowed
  • An enum member is removed or renamed
  • Generic type parameters are added, removed, or reordered
  • A type is changed from a type alias to an interface (or vice versa) in a way that breaks assignability

4. Visual / layout change

A change to styles, spacing, sizing, or visual output that would shift the consumer's application layout or appearance without any API-level change.

Examples:

  • Default margin, padding, or gap values changed
  • Component dimensions (width, height, min/max) changed
  • CSS display, position, or flex properties changed
  • Default visual variants or theme token mappings changed
  • Border, border-radius, or shadow values changed
  • Font size, line height, or font weight defaults changed

5. DOM / element structure change (web packages only)

Applies to packages/web/ only. Changes to the rendered HTML element tree that could break consumer CSS selectors or DOM queries targeting internal component structure.

Examples:

  • Wrapper elements added or removed
  • Element tag names changed (e.g., div -> section)
  • Nesting order of child elements changed
  • CSS class names or data attributes on internal elements removed or renamed
  • role or aria-* attributes removed or changed

6. Behavioral change

A change in runtime behavior that could break consumer expectations even though the API signature remains the same.

Examples:

  • Event handler calling conventions changed (e.g., different event object shape)
  • State management or controlled/uncontrolled behavior changed
  • Animation or transition behavior changed
  • Focus management behavior changed
  • Accessibility behavior changed (e.g., keyboard navigation patterns)

Output format

Organize findings by package. Within each package, group by category. For each breaking change, include:

  • Entity: The name of the affected component, type, function, hook, etc.
  • Category: One of the categories above
  • Description: A concise explanation of what changed and why it is breaking
  • File: The file path where the change occurred
  • Commit: The commit SHA that introduced the change

Use this structure:


packages/<package-name>/

Removals

| Entity | Description | File | Commit | | ------ | ----------- | ---- | ------ | | ... | ... | ... | ... |

API Changes

| Entity | Description | File | Commit | | ------ | ----------- | ---- | ------ | | ... | ... | ... | ... |

(Continue for each category that has findings. Omit empty categories.)


(Repeat for each package that has breaking changes. Omit packages with no breaking changes.)

Summary

After the per-package breakdown, provide a brief summary section:

  1. Total breaking changes by category across all packages
  2. Highest-risk changes: call out the changes most likely to cause widespread consumer breakage
  3. Migration notes: brief guidance on what consumers would need to do to adapt to each breaking change

Important guidelines

  • Be thorough but precise. Do not flag internal refactors that do not affect the public API.
  • When in doubt about whether something is publicly exported, trace the export chain from package.json exports -> barrel files -> source modules.
  • For visual/layout changes, note the before and after values when possible.
  • For DOM structure changes, describe the structural difference clearly enough that a consumer could update their CSS selectors.
  • Do not speculate. Only report changes you can verify from the diff.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/detect-breaking-changes-in-cds-public-api-mryiqihh/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/detect-breaking-changes-in-cds-public-api-mryiqihh' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/detect-breaking-changes-in-cds-public-api-mryiqihh/download' --output '.skill-downloads/detect-breaking-changes-in-cds-public-api-mryiqihh/SKILL.md.part' && mv '.skill-downloads/detect-breaking-changes-in-cds-public-api-mryiqihh/SKILL.md.part' '.skill-downloads/detect-breaking-changes-in-cds-public-api-mryiqihh/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Bash(git log:*), Bash(git show:*), Bash(git diff:*), Bash(git rev-parse:*), Read, Glob, Grep

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Le fichier ne fournit pas un en-tête name/description exploitable pour cette procédure native. Le téléchargement reste disponible pour lecture ; utilisez le mode manuel ci-dessous.

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/detect-breaking-changes-in-cds-public-api-mryiqihh/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires