Note
GitHub Copilot Extensions は パブリック プレビュー 段階であり、変更される可能性があります。
サーバーを構成し、GitHub App を作成したら、Copilot 拡張機能で使うように GitHub App を構成する必要があります。
前提条件
- Copilot Extension を配置するようにサーバーを構成しており、ホスト名 (転送エンドポイントとも呼ばれる) があります。 詳しくは、「Copilot 拡張機能をホストするためのサーバーの構成」をご覧ください。
- Copilot 拡張機能用の GitHub App を作成してあります。 詳しくは、「Copilot 拡張機能用の GitHub アプリの作成」をご覧ください。
GitHub App の構成
-
GitHub の任意のページの右上隅にある、自分のプロファイル写真をクリックします。
-
アカウント設定にアクセスしてください。
- 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
- 組織が所有するアプリの場合:
- [自分の組織] をクリックします。
- 組織の右側にある [設定] をクリックします。
-
左側のサイドバーで [ 開発者設定] をクリックします。
-
左側のサイドバーで、 [GitHub Apps] をクリックします。
-
Copilot Extension の場合、構成する GitHub App の右側にある [編集] をクリックします。
-
[Identifying and authorizing users] セクションの [Callback URL] にコールバック エンドポイント URL を入力し、[Save changes] をクリックします。
Note
サーバーのホスト名は、サーバーを構成したときにターミナルからコピーした転送エンドポイントです。 「Copilot 拡張機能をホストするためのサーバーの構成」を参照してください。
ngrok でエフェメラル ドメインを使用している場合は、ngrok サーバーを再起動するたびにこの URL を更新する必要があります。
-
左側のサイドバーで、[アクセス許可とイベント] をクリックします。
-
[アカウントのアクセス許可] セクションの展開には、セクション内の任意の場所をクリックします。
-
「GitHub Copilot Chat」の行で、「アクセス:」ドロップダウンメニューを選択し、「読み取り専用」をクリックします。
-
アプリケーションがエディターの内容 (現在開いているファイルなど) を受け取れるようにするには、[Copilot Editor Context] 行で [Access:] ドロップダウン メニューを選んで、[Read-only] をクリックします。
-
[変更を保存] をクリックします。
-
左側のサイドバーで、[Copilot] をクリックします。
-
GitHub Marketplace 開発者契約およびGitHub プレリリースライセンス条項を読み、Copilot Extensionを作成するための条項に同意します。
-
[アプリの種類] セクションで、ドロップダウン メニューを選択して、 Agent をクリックします。
-
「URL」の欄には、ターミナルからコピーしたサーバーのホスト名(転送エンドポイントとも呼ばれる)を入力します。
Note
ngrok でエフェメラル ドメインを使用している場合は、ngrok サーバーを再起動するたびにこの URL を更新する必要があります。
-
[推論の説明] で、エージェントの簡単な説明を入力し、[ 保存] をクリックします。 これは、ユーザーがチャット ウィンドウで拡張機能のスラッグをポイントしたときに表示される説明です。
-
事前承認 URL は、拡張機能の承認プロセスを開始する Web サイト上のリンクです。 拡張機能を承認すると、ユーザーはこの URL にリダイレクトされます。 事前承認 URL を使用している場合は、[事前承認 URL] に URL を入力し、[変更の保存] をクリックします。
-
GitHub App 設定の左側のサイドバーで、[アプリのインストール] をクリックし、アプリをインストールするアカウントの横にある [インストール] をクリックします。
-
GitHub の任意のページの右上で、検索バーの横にある GitHub Copilot アイコンをクリックします。
GitHub Copilot Chat パネルが表示されます。 パネルのサイズ変更を行うには、上端または左端をクリックしてドラッグします。
-
パネルに Copilot で行った以前の会話が含まれている場合は、パネルの右上にある [新しい会話] アイコン (プラス記号) をクリックします。
-
拡張機能を呼び出すには、「
@EXTENSION-NAME
」と入力し、拡張機能名内のスペースを-
に置き換えてから、Enter
を押します。 -
拡張機能を初めて使用する場合は、認証を求められます。 画面の手順に従って拡張機能を認証します。
-
チャット ウィンドウで拡張機能に質問します。 たとえば、
What is the software development lifecycle?
のようにします。
-
GitHub の任意のページの右上隅にある、自分のプロファイル写真をクリックします。
-
アカウント設定にアクセスしてください。
- 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
- 組織が所有するアプリの場合:
- [自分の組織] をクリックします。
- 組織の右側にある [設定] をクリックします。
-
左側のサイドバーで [ 開発者設定] をクリックします。
-
左側のサイドバーで、 [GitHub Apps] をクリックします。
-
Copilot Extension の場合、構成する GitHub App の右側にある [編集] をクリックします。
-
[Identifying and authorizing users] セクションの [Callback URL] にコールバック エンドポイント URL を入力し、[Save changes] をクリックします。
Note
サーバーのホスト名は、サーバーを構成したときにターミナルからコピーした転送エンドポイントです。 「Copilot 拡張機能をホストするためのサーバーの構成」を参照してください。
ngrok でエフェメラル ドメインを使用している場合は、ngrok サーバーを再起動するたびにこの URL を更新する必要があります。
-
左側のサイドバーで、[アクセス許可とイベント] をクリックします。
-
[アカウントのアクセス許可] セクションの展開には、セクション内の任意の場所をクリックします。
-
「GitHub Copilot Chat」の行で、「アクセス:」ドロップダウンメニューを選択し、「読み取り専用」をクリックします。
-
アプリケーションがエディターの内容 (現在開いているファイルなど) を受け取れるようにするには、[Copilot Editor Context] 行で [Access:] ドロップダウン メニューを選んで、[Read-only] をクリックします。
-
[変更を保存] をクリックします。
-
左側のサイドバーで、[Copilot] をクリックします。
-
GitHub Marketplace 開発者契約およびGitHub プレリリースライセンス条項を読み、Copilot Extensionを作成するための条項に同意します。
-
[App type] セクションでドロップダウン メニューを選んで、[Skillset] をクリックします。
-
事前承認 URL は、拡張機能の承認プロセスを開始する Web サイト上のリンクです。 拡張機能を承認すると、ユーザーはこの URL にリダイレクトされます。 事前承認 URL を使用している場合は、[事前承認 URL] に URL を入力し、[変更の保存] をクリックします。
-
追加するスキルごとに (最大 5):
- [Add new skill] をクリックします。
- スキルの明確な [Name] を入力します (例: "Generate Lorem Ipsum Data")。
- Copilot がこのスキルを使うべきときを理解するのに役立つ、詳細な [Inference description] を書きます。
- POST 要求を受け取る [API endpoint URL] を追加します。
- [Parameter] フィールドに、予想される要求形式を定義する JSON スキーマを追加します。
- [Add Definition] をクリックしてスキルを保存します。
-
[Save] をクリックしてスキルセットを保存します。
-
GitHub App 設定の左側のサイドバーで、[アプリのインストール] をクリックし、アプリをインストールするアカウントの横にある [インストール] をクリックします。
-
GitHub の任意のページの右上で、検索バーの横にある GitHub Copilot アイコンをクリックします。
GitHub Copilot Chat パネルが表示されます。 パネルのサイズ変更を行うには、上端または左端をクリックしてドラッグします。
-
パネルに Copilot で行った以前の会話が含まれている場合は、パネルの右上にある [新しい会話] アイコン (プラス記号) をクリックします。
-
拡張機能を呼び出すには、「
@EXTENSION-NAME
」と入力し、拡張機能名内のスペースを-
に置き換えてから、Enter
を押します。 -
拡張機能を初めて使用する場合は、認証を求められます。 画面の手順に従って拡張機能を認証します。
-
チャット ウィンドウで拡張機能に質問します。 たとえば、
What is the software development lifecycle?
のようにします。