Configuring your GitHub App for your Copilot extension

Learn how to configure your GitHub App so that it is associated with your Copilot Extension.

Tool navigation

この記事の内容

Note

GitHub Copilot Extensions is in パブリック プレビュー and subject to change.

Once you have configured your server and created your GitHub App, you need to configure your GitHub App for use with your Copilot extension.

Prerequisites

Configuring your GitHub App

  1. GitHub の任意のページの右上隅にある、自分のプロファイル写真をクリックします。

  2. アカウント設定にアクセスしてください。

    • 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
    • 組織が所有するアプリの場合:
      1. [自分の組織] をクリックします。
      2. 組織の右側にある [設定] をクリックします。

  3. 左側のサイドバーで [ 開発者設定] をクリックします。

  4. 左側のサイドバーで、 [GitHub Apps] をクリックします。

  5. To the right of the GitHub App you want to configure for your Copilot Extension, click Edit.

  6. In the "Identifying and authorizing users" section, under "Callback URL", enter your server's hostname, then click Save changes.

    Note

    This step is only required if you intend to request user authorization (OAuth) during installation.

    Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. For more information, see "Configuring your server to host your Copilot extension."

    If you are using an ephemeral domain in ngrok, you will need to update this URL every time you restart your ngrok server.

  7. In the left sidebar, click Permissions & events.

  8. To expand the "Account permissions" section, click anywhere in the section.

  9. In the "GitHub Copilot Chat" row, select the Access: dropdown menu, then click Read-only. Click Save changes.

  10. In the left sidebar, click Copilot.

  11. Read the GitHub Marketplace Developer Agreement and the GitHub Pre-release License Terms, then accept the terms for creating a Copilot Extension.

  12. In the "App type" section, select the dropdown menu, then click Agent.

  13. Under "URL," enter your server's hostname (aka forwarding endpoint) that you copied from your terminal.

    Note

    If you are using an ephemeral domain in ngrok, you will need to update this URL every time you restart your ngrok server.

  14. Under "Inference description", type a brief description of your agent, then click Save. This will be the description users see when they hover over your extension's slug in the chat window.

  15. Your pre-authorization URL is a link on your website that starts the authorization process for your extension. Users will be redirected to this URL when they decide to authorize your extension. If you are using a pre-authorization URL, under "Pre-authorization URL," enter the URL, then click Save changes.

  16. In your GitHub App settings, in the left sidebar, click Install App, then, next to the account you want to install your app on, click Install.

  17. GitHub の任意のページで、ページの右下にある GitHub Copilot アイコンをクリックします。

    GitHub Copilot Chat パネルが表示されます。 パネルのサイズ変更を行うには、上端または左端をクリックしてドラッグします。

  18. パネルに Copilot で行った以前の会話が含まれている場合は、パネルの右上にある [新しい会話] アイコン (プラス記号) をクリックします。

    新しい会話ボタンのスクリーンショット。濃いオレンジ色の枠線で強調表示されています。

  19. Invoke your extension by typing @EXTENSION-NAME, replacing any spaces in the extension name with -, then press Enter.

  20. If this is your first time using the extension, you will be prompted to authenticate. Follow the steps on screen to authenticate your extension.

  21. Ask your extension a question in the chat window. For example, What is the software development lifecycle?.

  1. GitHub の任意のページの右上隅にある、自分のプロファイル写真をクリックします。

  2. アカウント設定にアクセスしてください。

    • 個人用アカウントが所有するアプリの場合は、[設定] をクリックします。
    • 組織が所有するアプリの場合:
      1. [自分の組織] をクリックします。
      2. 組織の右側にある [設定] をクリックします。

  3. 左側のサイドバーで [ 開発者設定] をクリックします。

  4. 左側のサイドバーで、 [GitHub Apps] をクリックします。

  5. To the right of the GitHub App you want to configure for your Copilot Extension, click Edit.

  6. In the "Identifying and authorizing users" section, under "Callback URL", enter your server's hostname, then click Save changes.

    Note

    This step is only required if you intend to request user authorization (OAuth) during installation.

    Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. For more information, see "Configuring your server to host your Copilot extension."

    If you are using an ephemeral domain in ngrok, you will need to update this URL every time you restart your ngrok server.

  7. In the left sidebar, click Permissions & events.

  8. To expand the "Account permissions" section, click anywhere in the section.

  9. In the "GitHub Copilot Chat" row, select the Access: dropdown menu, then click Read-only. Click Save changes.

  10. In the left sidebar, click Copilot.

  11. Read the GitHub Marketplace Developer Agreement and the GitHub Pre-release License Terms, then accept the terms for creating a Copilot Extension.

  12. In the "App type" section, select the dropdown menu, then click Skillset.

  13. Your pre-authorization URL is a link on your website that starts the authorization process for your extension. Users will be redirected to this URL when they decide to authorize your extension. If you are using a pre-authorization URL, under "Pre-authorization URL," enter the URL, then click Save changes.

  14. For each skill you want to add (maximum 5):

    1. Click Add new skill.
    2. Enter a clear Name for the skill (e.g., "Generate Lorem Ipsum Data").
    3. Write a detailed Inference description to help Copilot understand when to use this skill.
    4. Add your API endpoint URL that will receive the POST requests.
    5. In the Parameter field, add the JSON schema defining the expected request format.
    6. Click Add Definition to save your skill.

  15. Click Save to save your skillset.

  16. In your GitHub App settings, in the left sidebar, click Install App, then, next to the account you want to install your app on, click Install.

  17. GitHub の任意のページで、ページの右下にある GitHub Copilot アイコンをクリックします。

    GitHub Copilot Chat パネルが表示されます。 パネルのサイズ変更を行うには、上端または左端をクリックしてドラッグします。

  18. パネルに Copilot で行った以前の会話が含まれている場合は、パネルの右上にある [新しい会話] アイコン (プラス記号) をクリックします。

    新しい会話ボタンのスクリーンショット。濃いオレンジ色の枠線で強調表示されています。

  19. Invoke your extension by typing @EXTENSION-NAME, replacing any spaces in the extension name with -, then press Enter.

  20. If this is your first time using the extension, you will be prompted to authenticate. Follow the steps on screen to authenticate your extension.

  21. Ask your extension a question in the chat window. For example, What is the software development lifecycle?.