backstage-api-changes

RHDH Backstage API の変更点

NFS API の差分を一元管理します。2 つのスキルがこの情報を必要としていますが、どちらも所有していないため、ここに置き、両方が名前を指定して呼び出します。

呼び出し元

• /rhdh-backstage-upgrade はバージョン番号を担当します。アップグレードによってチェックアウトがこの差分のいずれかをまたぎ、NFS コードのコンパイルが失敗した場合に、ここを参照します。
• /rhdh-plugin-nfs-migration は拡張機能の構造を担当します。古いアルファ版を基にプラグインがすでに移行されていた場合や、古いガイドに記載された Blueprint のパラメーターによって TypeScript エラーが発生した場合に、ここを参照します。

これが、2 つのスキルの境界でもあります。バージョン番号はアップグレードスキルの担当です。拡張機能がどの Blueprint になるか、またどこに接続されるかは、移行スキルの担当です。このスキルは両方の下位に位置し、どちらにも属しません。API の変更点だけを説明し、どの変更を適用すべきかは示しません。

インターフェース

references/api-changes.md を読みます。変更ごとに 1 つのセクションがあり、それぞれ旧形式、新形式、およびシンボルの移行先パッケージが記載されています。

手元のコードに対するチェックリストとして使用してください。次の 2 点に注意してください。

• ここでは初期のアルファ版から現在の GA までの差分を説明しています。リリースごとの変更履歴ではなく、アップグレード対象となる各リリースの変更履歴を読むことの代わりにはなりません。
• アップストリームの API は変わり続けています。この説明と node_modules/@backstage/frontend-plugin-api の型定義が食い違う場合は、型定義を優先し、説明に従うのではなく、その食い違いを報告してください。

完了

手元のコードに該当する変更、移行先の正確なシンボルとパッケージ、解決できなかった箇所を報告し、結果をこのスキルの呼び出し元に返してください。