Создание приложения GitHub

Сведения о создании GitHub Apps

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

Создание GitHub App

1. Перейдите к настройкам учетной записи.

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

   • Для приложения GitHub App, принадлежащего организации, нажмите на фото своего профиля в правом верхнем углу любой страницы и выберите Ваши организации. Затем нажмите Настройки справа от организации.

     

2. На левой боковой панели щелкните Параметры разработчика.

3. На левой боковой панели щелкните GitHub Apps.

4. Нажмите кнопку Создать приложение GitHub.

5. В разделе "Приложение GitHub имя" введите имя приложения. Следует выбрать понятное и короткое имя. Имя приложения (преобразованное в нижний регистр, с пробелами -, замененными на , и с замененными специальными символами) будет отображаться в пользовательском интерфейсе, когда приложение выполняет действие. Например, My APp Näme будет отображаться как my-app-name.

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

6. При необходимости в разделе "Описание" введите описание приложения. Пользователи и организации увидят это описание при установке приложения.

7. В разделе "URL-адрес домашней страницы" введите полный URL-адрес веб-сайта приложения. Если у вас нет выделенного URL-адреса и код приложения хранится в общедоступный репозиторий, можно использовать этот URL-адрес репозитория. Вы также можете использовать URL-адрес организации или пользователя, которым принадлежит приложение.

8. При необходимости в разделе "URL-адрес обратного вызова" введите полный URL-адрес для перенаправления после авторизации установки пользователем.

   Можно ввести до 10 URL-адресов обратного вызова. Чтобы добавить дополнительные URL-адреса обратного вызова, щелкните Добавить URL-адрес обратного вызова.

   Если приложению не нужно действовать от имени пользователя (ей не нужно создавать маркер доступа пользователя), это поле будет игнорироваться. Если ваше приложение использует поток устройства вместо потока веб-приложения для создания маркера доступа пользователя, это поле будет игнорироваться.

   Дополнительные сведения о URL-адресе обратного вызова см. в разделе Сведения о URL-адресе обратного вызова авторизации пользователя. Дополнительные сведения о создании маркера доступа пользователя для действий от имени пользователя см. в разделах Проверка подлинности с помощью Приложение GitHub от имени пользователя и Создание маркера доступа пользователя для Приложение GitHub.

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

10. При необходимости, чтобы предложить пользователям авторизовать приложение при его установке, выберите Запросить авторизацию пользователя (OAuth) во время установки. Если пользователь авторизует приложение, приложение может создать маркер доступа пользователя, чтобы выполнять запросы API от имени пользователя и атрибутировать действия приложения пользователю. Дополнительные сведения см. в разделах Проверка подлинности с помощью Приложение GitHub от имени пользователя и Создание маркера доступа пользователя для Приложение GitHub.

11. Если вы хотите использовать поток устройства для создания маркера доступа пользователя, выберите Включить поток устройств. Дополнительные сведения см. в разделе Создание маркера доступа пользователя для Приложение GitHub.

12. При необходимости в разделе "URL-адрес установки" введите URL-адрес для перенаправления пользователей после установки приложения. Если после установки требуется дополнительная настройка, вы можете использовать этот URL-адрес, чтобы сообщить пользователям, какие действия следует предпринять после установки. Дополнительные сведения см. в разделе Сведения о URL-адресе установки.

    Если вы выбрали Запрос авторизации пользователя (OAuth) во время установки на предыдущем шаге, вы не сможете ввести ЗДЕСЬ URL-адрес. Вместо этого пользователи будут перенаправлены на URL-адрес обратного вызова в рамках потока авторизации, где можно описать дополнительную настройку.

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

14. При необходимости, если вы не хотите, чтобы приложение получало события веб-перехватчика, снимите флажок Активный. Например, если ваше приложение будет использоваться только для проверки подлинности или не должно реагировать на веб-перехватчики, снимите этот флажок. Дополнительные сведения см. в разделе Использование веб-перехватчиков с приложениями GitHub.

15. Если вы выбрали активный на предыдущем шаге, в разделе "URL-адрес веб-перехватчика" введите URL-адрес, по которому GitHub должен отправлять события веб-перехватчика. Дополнительные сведения см. в разделе Использование веб-перехватчиков с приложениями GitHub.

16. При необходимости, если вы выбрали активный на предыдущем шаге, в разделе "Секрет веб-перехватчика" введите маркер секрета для защиты веб-перехватчиков. GitHub настоятельно рекомендует задать секрет веб-перехватчика. Дополнительные сведения см. в разделе Использование веб-перехватчиков с приложениями GitHub.

17. Если вы ввели URL-адрес веб-перехватчика, в разделе "Проверка SSL" выберите, следует ли включить проверку SSL. GitHub настоятельно рекомендует включить проверку SSL.

18. В разделе "Разрешения" выберите разрешения, необходимые приложению. Для каждого разрешения выберите раскрывающееся меню и щелкните Только для чтения, Чтение & запись или Нет доступа. Необходимо выбрать минимальные разрешения, необходимые для вашего приложения. Дополнительные сведения см. в разделе Выбор разрешений для Приложение GitHub.

19. Если вы выбрали активный на предыдущем шаге, чтобы указать, что приложение должно получать события веб-перехватчика, в разделе "Подписка на события" выберите события веб-перехватчика, которые должно получать приложение. Разрешения, выбранные на предыдущем шаге, определяют доступные события веб-перехватчика. Дополнительные сведения о каждом событии веб-перехватчика см. в разделе События и полезные данные веб-перехватчика.

20. В разделе "Где можно установить этот Приложение GitHub?" выберите Только для этой учетной записи или Любой учетной записи. Дополнительные сведения о параметрах установки см. в разделе Преобразование приложения GitHub в общедоступное или частное.

21. Нажмите кнопку Создать приложение GitHub.

Дополнительные материалы

• "Изменение приложения GitHub"