Skip to main content

Creating a GitHub App for your Copilot Extension

Learn how to create a GitHub App for your Copilot Extension.

Note

GitHub Copilot Extensions 为 beta,可能随时更改。

A Copilot Extension is a GitHub App that is associated with a Copilot agent. The GitHub App you associate your Copilot agent with is used to authenticate the Copilot agent with GitHub and to authorize the Copilot agent to access the Copilot Chat API. Each Copilot agent must be associated with a unique GitHub App.

Prerequisites

Creating a GitHub App

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

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

    • 对于由个人帐户拥有的应用,请单击“设置”****。
    • 对于组织拥有的应用:
      1. 单击“你的组织”。
      2. 在组织右侧,单击“设置”。
  3. 在左侧边栏中,单击“ 开发人员设置”。

  4. 在左侧边栏中,单击“GitHub Apps”。

  5. Click New GitHub App.

  6. Under "GitHub App name," enter a name for your app.

    Note

    The name cannot be longer than 34 characters.

    Your app's name will be shown in the user interface when your app takes an action. Uppercase letters will be converted to lowercase, with spaces replaced by -, and accents ignored. For example, My APp Näme would display as my-app-name.

    The name must be unique across GitHub. You cannot use the same name as an existing GitHub account, unless it is your own user or organization name.

  7. Optionally, under "Description," type a description of your app. Users and organizations will see this description when they install your app.

  8. Under "Homepage URL," enter a URL for your app. You can use:

    • Your app's website URL.
    • The URL of the organization or user that owns the app.
    • The URL of the repository where your app's code is stored, if it is a public repository.
  9. Under "Webhook," deselect Active.

  10. Click Create GitHub App.

Next steps