Marketplace では、サポートされている Copilot クライアント用のプラグインが配布されます。 これらは、GitHub を含むリポジトリ、別の Git ホスト、またはローカル ディレクトリでホストできます。 この記事では、GitHub リポジトリにマーケットプレースを公開する方法について説明します。 概要については、「GitHub Copilot 用のプラグイン」を参照してください。
始める前の準備
- ユーザーが使用するクライアントで動作するプラグインを 1 つ以上作成します。 GitHub Copilot CLI形式と作成のガイダンスについては、用のプラグインを作成する GitHub Copilot CLI を参照してください。
- Visual Studio Code形式とオーサリングのガイダンスについては、エージェント プラグインの作成リファレンスを参照してください。
engineering-toolsなど、安定した kebab ケースのマーケットプレース名を選択します。 プラグイン識別子にはこの名前が含まれているため、変更すると、ユーザーが設定とコマンドで使用する識別子が変更されます。
Marketplace リポジトリを作成する
マーケットプレースのリポジトリを作成します。 プラグイン マーケットプレース スターター テンプレートから開始し、その README に従って開発依存関係をインストールし、マーケットプレース名を設定するか、ファイルを自分で作成できます。 テンプレートを使用する場合は、共有したくないサンプルプラグインを削除します。
marketplace.jsonに.github/plugin/カタログ ファイルを追加します。- 各プラグイン ディレクトリを、
sourceフィールドに記載されているパスに追加します。 たとえば、ソースが./plugins/frontend-designの場合は、リポジトリのfrontend-designの下にplugins/ディレクトリを追加します。 - マーケットプレースの
nameに安定した kebab ケース値を追加します。 - マーケットプレースを維持する方法に合わせて、
.github/CODEOWNERS、コントリビューション手順、発行および pull request テンプレートを更新します。 - スターター テンプレートを使用する場合は、その README に従って
npm run verifyを実行してください。 このテンプレートでは、このコマンドをカタログ、マニフェスト、テスト、および評価カバレッジをチェックするものとして説明します。.github/workflows/validate.ymlワークフローを有効のままにして、プル リクエストとプッシュに対してモデルフリーのチェックを実行します。 テンプレートのチェックは変更される可能性があるため、現在の README とワークフローを確認してください。
marketplace.json ファイルは、必要なマーケットプレース カタログです。 マーケットプレースのメタデータを提供し、プラグインを一覧表示します。 最上位の plugins フィールドは、各プラグインの名前、説明、バージョン、ソースなどのメタデータを含むプラグイン エントリの配列です。 サンプル カタログについては、marketplace.json の github/awesome-copilot を参照してください。
サポートされているカタログ フィールドとその他のマーケットプレース ファイルの場所については、 プラグインとマーケットプレースのリファレンス を参照してください。
マーケットプレースを確認して維持する
共有エージェント インフラストラクチャの変更としてプラグインを確認します。 更新プログラムを公開する前にプラグインの動作をテストし、評価は意図した評価対象のコンテキストに関連付けて保持します。 リポジトリを更新するときに、カタログ エントリとプラグイン ソースを確認します。
マーケットプレイスを共有
マーケットプレースを追加したり、そのマーケットプレースのプラグインを取得したりするユーザーは、リポジトリへの読み取りアクセス権が必要であり、クライアントで GitHub にサインインする必要があります。 プライベート マーケットプレースの場合は、組織でホストし、そのユーザーにアクセスを許可します。 組織のメンバーシップだけでは、プライベート リポジトリへのアクセスは保証されません。
リポジトリを発行したら、その URL をクライアントに追加する必要がある人と共有します。 また、共有設定を通じてプラグインを利用可能にすることもできます。
- 個人利用の場合は、そのマーケットプレースのプラグインを使用したいクライアントにマーケットプレースを追加します。 クライアントの手順については、 Visual Studio Code でプラグインを使用する、 GitHub Copilot CLI のプラグインの検索とインストール、または GitHub Copilot アプリのカスタマイズ を参照してください。
- リポジトリの場合は、
.github/copilot/settings.jsonでマーケットプレースとプラグインの既定値を宣言します。 コントリビューターは、サポートされている画面でリポジトリの既定値をローカルでオーバーライドできます。 Copilot in the cloud では、これらのリポジトリ設定が使用され、ローカルオーバーライドはありません。 「GitHub Copilot CLI の構成ディレクトリ」を参照してください。 - エンタープライズ要件の場合は、マネージド設定を使用してマーケットプレースを利用可能にし、プラグインを必須にするかブロックします。 「エンタープライズ管理設定を使用したプラグインマーケットプレースとプラグインの管理」を参照してください。