mcpField
B
backstage-api-changes

backstage-api-changes

github.com/redhat-developerDevelopment1945 installsUpdated 1d ago
Repository

About backstage-api-changes

backstage-api-changes is a reference skill for RHDH Backstage API changes, used by upgrade and plugin-migration skills. It maps old and new API forms and packages, without prescribing which code change to make.

Key features

  1. 01Old and new API forms
  2. 02Package location for moved symbols
  3. 03Checklist for code review
  4. 04Notes API changes from early alpha to GA

Use cases

  1. 01Check API deltas after a version upgrade
  2. 02Resolve TypeScript errors from older plugin migrations

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/redhat-developer/rhdh-skills --skill backstage-api-changes

After installing, type/backstage-api-changesin Claude Code to confirm it loaded.

Bundled filesagents/openai.yamlreferences/api-changes.md

Details

From the project README

RHDH Backstage API Changes

A single home for the NFS API deltas. Two skills need this material and neither owns it, so it lives here and both invoke it by name.

Who invokes this

  • /rhdh-backstage-upgrade owns version numbers. It arrives here when a bump moves a checkout across one of these deltas and NFS code stops compiling.
  • /rhdh-plugin-nfs-migration owns extension shape. It arrives here when a plugin was already migrated against an older alpha, or when a Blueprint param from an older guide produces a TypeScript error.

That is also the boundary between those two skills. A version number is the upgrade skill's business; which Blueprint an extension becomes and where it attaches is the migration skill's. This skill sits under both and belongs to neither: it says only what changed in the API, not which change you should make.

Interface

Read references/api-changes.md. It is organized one section per change, each with the old form, the new form, and the package the symbol now comes from.

Consume it as a checklist against the code in front of you. Two cautions:

  • It describes the delta from the early alpha to current GA. It is not a release-by-release changelog, and it does not replace reading the changelogs for the specific releases an upgrade spans.
  • The upstream surface keeps moving. When this prose and the type definitions in node_modules/@backstage/frontend-plugin-api disagree, the type definitions win — report the disagreement rather than following the prose.

Completion

Report which of these changes apply to the code in hand, the exact symbol and package each one moves to, any occurrence you could not resolve, and hand the result back to the skill that invoked this one.

Comments

Markdown supported