Написание кода для приложения 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)".

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

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

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

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

Учетные данные из регистрации GitHub App можно использовать для выполнения прошедших проверку подлинности запросов к API GitHub. Дополнительные сведения см. в разделе Сведения о проверке подлинности с помощью приложения GitHub.

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

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

  • Если приложение использует поток веб-приложения для авторизации пользователя, может потребоваться обновить параметр "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 App более обнаруживаемыми, его можно перечислить на GitHub Marketplace. Дополнительные сведения см. в разделе "Общий доступ к приложению GitHub".