mcpField
R
rhdh-plugin-export

rhdh-plugin-export

github.com/redhat-developer開発1945 回インストール1 日前に更新
リポジトリ

rhdh-plugin-export について

開発中のプラグインを作業ディレクトリからデプロイ可能な成果物へエクスポートするスキルです。ビルドや OCI イメージ、tgz アーカイブ、npm パッケージへの梱包、任意のレジストリ公開と整合性情報の扱いを案内します。

主な機能

  1. 01プラグインのビルドと TypeScript コンパイルを確認
  2. 02プラグインを dist-dynamic/ にエクスポート
  3. 03OCI イメージ、tgz、npm パッケージに梱包
  4. 04共有・埋め込み・同梱依存関係を選択
  5. 05整合性値を生成または検証

活用シーン

  1. 01ローカル開発プラグインをデプロイ用に梱包
  2. 02エクスポートした成果物をレジストリに公開
  3. 03動的プラグインの接続に使う成果物参照を準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/redhat-developer/rhdh-skills --skill rhdh-plugin-export

インストール後、Claude Code で/rhdh-plugin-exportを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

agents/
openai.yaml
examples/
dynamic-plugins.yaml
references/
export-options.md
export.md
integrity-hashes.md
packaging-formats.md
scripts/
export-plugin.py

詳細

RHDH プラグインのエクスポート

開発中のソースからデプロイ可能なアーティファクトに至る工程を担います。プラグインをビルドして dist-dynamic/ にエクスポートし、3 種類の形式のいずれかでパッケージ化します。必要に応じて、デプロイ時に固定できる整合性値とともにレジストリに登録します。

/rhdh-overlay との対象範囲の違い

このスキルは、ご自身が開発しているプラグインを、自身のワークスペースからご自身のマシン上でエクスポートします。/rhdh-overlay は オーバーレイリポジトリの CI エクスポート(source.json、plugins-list.yaml、および Extensions Catalog 向けに rhdh-plugin-export-overlays が実行するエクスポートジョブ)を修復します。失敗したエクスポートがそのリポジトリの GitHub Actions の実行である場合、このスキルの対象ではありません。

まずはこちら

  1. プラグインがビルドできることを確認します。プラグインのディレクトリで yarn build と yarn tsc を実行します。
  2. package.json を確認して、プラグインの役割、名前、バージョンを把握します。また、バックエンドプラグインには src/index.ts からのデフォルトエクスポートがあることを確認します。
  3. 実行前にターゲット形式を決めます。OCI イメージ、tgz アーカイブ、npm パッケージのいずれかです。

結果に応じた手順

結果読み込んで従う内容
エクスポートとパッケージ化を一度に行うreferences/export.md。scripts/export-plugin.py を実行します
共有、埋め込み、バンドルする依存関係を選ぶreferences/export-options.md
特定のアーティファクト形式を比較または生成するreferences/packaging-formats.md
整合性値を生成または検証するreferences/integrity-hashes.md
デプロイ設定の全体例を確認するexamples/dynamic-plugins.yaml

同梱スクリプトは一般的な手順に対応しています。

python scripts/export-plugin.py --plugin-dir plugins/my-plugin \
  --tag quay.io/ns/my-plugin:v0.1.0 --push --clean

すべてのオプションを確認するには --help を指定して実行します。スクリプトのデフォルトが適さない場合は、references/export.md の手順に沿って進めます。

対象範囲外

  • このスキルが生成するのはアーティファクトです。プラグインのソース作成、デプロイ設定の生成、RHDH の実行は行いません。
  • /rhdh-plugin-authoring はプラグインのソースを担当します。ここで判明したデフォルトエクスポートの欠落やビルドの失敗も対象です。
  • /rhdh-plugin-wiring は、このスキルが生成するアーティファクトを使用する dynamic-plugins.yaml の設定を担当します。
  • /rhdh-local は、実行中のローカル RHDH へのアーティファクトのインストールを担当します。
  • /rhdh-overlay はオーバーレイリポジトリと Extensions Catalog を担当します。

会話の中で、名前を指定してスキルを呼び出し、引き継ぎ内容を説明します。他のスキルのファイルは開かないでください。

守るべき事項

  • レジストリ参照を決して推測で作成しないでください。パッケージ名、タグ、ダイジェストはエクスポートの出力とレジストリの応答から導き出します。
  • レジストリへのプッシュは外部への書き込みです。名前付きスキル mutation-gate を呼び出して、その指示に従います。操作対象は、正確なレジストリ、リポジトリ、タグです。
  • デプロイで安定したアーティファクトが必要な場合は、タグではなくダイジェストを優先します。
  • 生成されたパスと参照は、表記を変えずに報告します。推測した値を固定するデプロイは、ここから離れたインストール時に失敗します。

完了

実行したエクスポートコマンド、アーティファクト形式とその正確な参照またはパス、共有依存関係と埋め込み依存関係の選択、生成された整合性値、プッシュの有無とプッシュ先、配線設定またはローカルでの検証のために次に呼び出す名前付きスキルを報告します。

コメント