关于 backstage-api-changes
backstage-api-changes 是供 RHDH 升级和插件迁移技能使用的 Backstage API 变更参考。它列出旧、新 API 形式及符号所属包,但不规定应如何修改代码。
主要功能
- 01列出 API 的旧、新形式
- 02标明迁移符号所属包
- 03作为代码检查清单
- 04记录早期 alpha 到 GA 的变化
适用场景
- 01升级版本后核对 API 差异
- 02排查旧插件迁移导致的 TypeScript 错误
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ redhat-developer/ rhdh-skills --skill backstage-api-changes安装后在 Claude Code 中输入/backstage-api-changes确认已加载。
附带文件agents/openai.yamlreferences/api-changes.md
详细介绍
RHDH Backstage API 变更
集中收录 NFS API 的差异。两项技能都需要这些内容,但都不负责维护,因此将其放在这里,由两者按名称调用。
调用方
/rhdh-backstage-upgrade负责版本号。当升级导致检出内容跨越以下某项差异,且 NFS 代码无法编译时,会调用这里。/rhdh-plugin-nfs-migration负责扩展形态。当插件已基于较早的 alpha 版本完成迁移,或较早指南中的 Blueprint 参数导致 TypeScript 错误时,会调用这里。
这也是这两项技能的职责边界。版本号归升级技能负责;扩展会变成哪种 Blueprint、以及挂载位置,则归迁移技能负责。这项技能由两者共同调用,但不属于任何一方:它只说明 API 发生了什么变化,不说明你应该做出哪种更改。
接口
阅读 references/api-changes.md。该文档按变更分节,每节都包含旧形式、新形式,以及该符号现在所属的包。
将其作为核对清单,对照当前代码逐项检查。请注意以下两点:
- 它描述的是从早期 alpha 到当前 GA 的差异,不是逐版本的变更日志,也不能替代对升级所跨越的具体版本的变更日志进行阅读。
- 上游接口仍在不断变化。如果本文与
node_modules/@backstage/frontend-plugin-api中的类型定义不一致,应以类型定义为准——报告不一致之处,而不是遵循本文。
完成
报告当前代码中适用的变更、每项变更所涉及的确切符号及其所属的包、任何无法解决的情况,并将结果交还给调用此技能的技能。
评论
支持 Markdown