О написании кода для приложения GitHub

Необходимо написать код, чтобы добавить функции в вашу GitHub App.

В этой статье

Необходимые компоненты

Перед написанием кода для нее GitHub Appнеобходимо зарегистрировать GitHub App. При регистрации GitHub Appприложения вы выбираете разрешения. Эти разрешения определяют, что GitHub App может сделать. При регистрации приложения вы также указываете другие параметры, включая события GitHub App веб-перехватчика, которые должны получать. Вы всегда можете изменить параметры регистрации GitHub App . Дополнительные сведения см. в разделе [AUTOTITLE и Регистрация приложения GitHub](/apps/maintaining-github-apps/modifying-a-github-app-registration).

Если вы хотите GitHub App получить доступ к репозиторию и /или данным организации, необходимо установить.GitHub App Дополнительные сведения см. в разделе Установка собственного приложения GitHub.

Написание кода для GitHub App

Чтобы GitHub App сделать что-то, необходимо написать код, чтобы добавить функции в ваш GitHub App.

Инструкции по написанию кода для примера см. в следующей GitHub Appстатье:

Вы можете использовать учетные данные из GitHub App регистрации, чтобы выполнить прошедшие проверку подлинности запросы к GitHubAPI. Дополнительные сведения см. в разделе Об аутентификации с помощью приложения GitHub.

Во время разработки вы, скорее всего, будете использовать личный компьютер или пространство кода для запуска.GitHub App Во время разработки GitHub App может потребоваться внести некоторые изменения в регистрацию:

  • Если ваше приложение получает webhooks, возможно, стоит использовать URL прокси webhook, чтобы перенаправлять их с GitHub на ваш компьютер или кодовое пространство. Необходимо обновить параметр url-адреса веб-перехватчика в GitHub App регистрации, чтобы использовать URL-адрес прокси-сервера веб-перехватчика. Пример см. в разделе Создание приложения GitHub, которое реагирует на события webhook.

  • Если приложение использует поток веб-приложения для авторизации пользователя, может потребоваться обновить параметр "URL-адрес обратного вызова" в GitHub App регистрации, чтобы использовать локальный URL-адрес обратного вызова. Пример см. в разделе Создание кнопки «Войти с помощью GitHub» с помощью приложения GitHub.

Следующие шаги

После написания кода необходимо GitHub Appубедиться, что он соответствует рекомендациям. При необходимости не забудьте обновить GitHub App регистрацию. Если вам GitHub App нужно запустить на сервере вместо устройства пользователя, разверните приложение на сервере. Наконец, вы можете поделиться своими GitHub App пользователями и организациями.

Применение рекомендаций

Перед развертыванием GitHub Appубедитесь, что вы следуйте рекомендациям. Например, убедитесь, что учетные GitHub Appданные защищены. Дополнительные сведения см. в разделе Лучшие практики создания приложения на GitHub.

GitHub App Обновление регистрации

Если вы изменили GitHub App регистрацию для разработки, обязательно обновите регистрацию, чтобы использовать готовые к работе значения. Например, если вы использовали URL-адрес прокси-сервера веб-перехватчика для разработки, необходимо обновить поле "URL-адрес веб-перехватчика", чтобы использовать URL-адрес, в котором вы хотите GitHub App получать веб-перехватчики во время рабочей среды.

Развертывание GitHub App

Когда вы напишете код для вашего GitHub Appкода, ваш код должен выполняться где-то. Если ваше приложение — сайт или веб-приложение, вы можете разместить его на сервере вроде Служба приложений Azure. Если ваше приложение является клиентским приложением, оно может работать на устройстве пользователя.

Общий доступ к вашему GitHub App

Если вы хотите поделиться своими GitHub App пользователями и организациями, вы должны сделать это GitHub App общедоступным. Дополнительные сведения см. в разделе Общий доступ к приложению GitHub.