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 为 公共预览版，可能随时更改。

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. 在组织的右侧，单击设置。
    • 对于由企业拥有的应用：
      1. 如果使用的是 Enterprise Managed Users，请单击你的企业，以直接转到企业帐户设置。
      2. 如果使用的是个人帐户，请单击你的企业，然后单击企业右侧的设置。

  3. 导航到 GitHub App 设置。

    • 对于由个人帐户或组织拥有的应用：
      1. 在左侧边栏中，单击 开发人员设置，然后单击 GitHub Apps。
    • 对于由企业拥有的应用：
      1. 在左侧边栏中，在“设置”下，单击 GitHub Apps。

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

  5. In the "Identifying and authorizing users" section, under "Callback URL", enter your callback endpoint URL, then click Save changes.

    Note

    Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. 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.

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

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

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

  9. In the left sidebar, click Copilot.

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

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

  12. 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.

  13. 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.

  14. 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.

  15. 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.

  16. 在 GitHub 的任何页面上，单击页面右下角的 GitHub Copilot 图标。

    此时将显示 GitHub Copilot Chat 面板。 要调整面板的大小，请单击并拖动顶部或左侧边缘。

  17. 如果面板包含与 Copilot 的前一次对话，请单击面板右上角的“新建对话”图标（加号）。

    “新建对话”按钮的屏幕截图，以深橙色边框突出显示。

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

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

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

  1. 在 GitHub 上任意页的右上角，单击你的个人资料照片。

  2. 导航到你的帐户设置。

    • 对于由个人帐户拥有的应用，请单击“设置”****。
    • 对于组织拥有的应用：
      1. 单击“你的组织”。
      2. 在组织的右侧，单击设置。
    • 对于由企业拥有的应用：
      1. 如果使用的是 Enterprise Managed Users，请单击你的企业，以直接转到企业帐户设置。
      2. 如果使用的是个人帐户，请单击你的企业，然后单击企业右侧的设置。

  3. 导航到 GitHub App 设置。

    • 对于由个人帐户或组织拥有的应用：
      1. 在左侧边栏中，单击 开发人员设置，然后单击 GitHub Apps。
    • 对于由企业拥有的应用：
      1. 在左侧边栏中，在“设置”下，单击 GitHub Apps。

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

  5. In the "Identifying and authorizing users" section, under "Callback URL", enter your callback endpoint URL, then click Save changes.

    Note

    Your server's hostname is the forwarding endpoint that you copied from your terminal when you configured your server. 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.

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

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

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

  9. In the left sidebar, click Copilot.

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

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

  12. 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.

  13. 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.

  14. Click Save to save your skillset.

  15. 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.

  16. 在 GitHub 的任何页面上，单击页面右下角的 GitHub Copilot 图标。

    此时将显示 GitHub Copilot Chat 面板。 要调整面板的大小，请单击并拖动顶部或左侧边缘。

  17. 如果面板包含与 Copilot 的前一次对话，请单击面板右上角的“新建对话”图标（加号）。

    “新建对话”按钮的屏幕截图，以深橙色边框突出显示。

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

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

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