Creating a GitHub App for your Copilot Extension

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

• You have created a Copilot agent. For more information, see "Building a Copilot agent for your Copilot Extension." Alternatively, you can use a demo agent. For more information, see "Using a demo agent."
• You have configured your server to deploy your Copilot agent, and you have your hostname (aka forwarding endpoint). For more information, see "Configuring your server to deploy your Copilot agent."

Creating a GitHub App

1. In the upper-right corner of any page on GitHub, click your profile photo.

2. Navigate to your account settings.

   • For an app owned by a personal account, click Settings.
   • For an app owned by an organization:
     1. Click Your organizations.
     2. To the right of the organization, click Settings.
   • For an app owned by an enterprise:
     1. If you use Enterprise Managed Users, click Your enterprise to go directly to the enterprise account settings.
     2. If you use personal accounts, click Your enterprises and then to the right of the enterprise, click Settings.

3. Navigate to the GitHub App settings.

   • For an app owned by a personal account or organization:
     1. In the left sidebar, click Developer settings, then click GitHub Apps.
   • For an app owned by an enterprise:
     1. In the left sidebar, under "Settings", click GitHub Apps.

4. Click New GitHub App.

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

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

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

8. Under "Webhook," deselect Active.

9. Click Create GitHub App.

Next steps

• Configuring your GitHub App for your Copilot agent