Skip to main content

Configuring your GitHub App for your Copilot agent

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

Note

GitHub Copilot Extensions은(는) beta 버전이며 변경될 수 있습니다.

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

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 deploy your Copilot agent."

    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 agent'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.com의 페이지에서 페이지 오른쪽 아래에 있는 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?.