Регистрация приложения GitHub

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

В этой статье

Сведения о регистрации GitHub Apps

Вы можете зарегистрировать несколько GitHub App различных способов.

Регистрация GitHub App

  1. В правом верхнем углу любой страницы на GitHubщелкните рисунок профиля.

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

    • Для приложения, принадлежащих личная учетная запись, нажмите кнопку "Параметры".
    • Для приложения, принадлежащих организации:
      1. Щелкните Your organizations (Ваши организации).
      2. Справа от организации нажмите кнопку "Параметры".
    • Для приложения, принадлежающего предприятия:
      1. Щелкните "Параметры предприятия".

  3. Перейдите к параметрам GitHub App .

    • Для приложения, принадлежащих личная учетная запись или организации:
      1. На левой боковой панели щелкните Параметры разработчика, а затем выберите GitHub Apps.
    • Для приложения, принадлежаемого предприятием:
      1. На левой боковой панели щелкните "Параметры **", а затем щелкните **GitHub Apps.

  4. Нажмите «Новое GitHub App».

  5. В разделе «GitHub App имя» введите имя вашего приложения. Вы должны выбрать четкое и короткое имя. Имя не может превышать 34 символов. Имя приложения (преобразовано в нижний регистр, пробелы заменены -и специальные символы заменены) будут отображаться в пользовательском интерфейсе при выполнении действия приложения. Например, 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-адресе обратного вызова авторизации пользователя. Дополнительные сведения о создании маркера доступа пользователя для действия от имени пользователя см. в разделе [AUTOTITLE и Аутентификация с помощью приложения GitHub от имени пользователя](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app).

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

  10. При необходимости, чтобы пользователи запросили авторизацию приложения при его установке, выберите "Запросить авторизацию пользователя" (OAuth) во время установки. Если пользователь авторизует приложение, приложение может создать маркер доступа пользователя для выполнения запросов API от имени пользователя и действия приложения атрибутов для пользователя. Дополнительные сведения см. в разделе [AUTOTITLE и Аутентификация с помощью приложения GitHub от имени пользователя](/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app).

  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 App можно установить?", выберите только в этой учетной записи или любой учетной записи. Дополнительные сведения о параметрах установки см. в разделе Как сделать приложение GitHub публичным или частным.

    Примечание.

    Если вы GitHub App зарегистрированы на предприятие, этот шаг не применяется.

  21. Нажмите «СоздатьGitHub App».

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

После регистрации GitHub Appнеобходимо написать код, чтобы сделать что-то GitHub App . Примеры написания кода см. в следующих примерах:

Вы должны стремиться следовать рекомендациям. Дополнительные сведения см. в разделе Лучшие практики создания приложения на GitHub.

GitHub App После полной сборки вы можете установить и GitHub App поделиться своими GitHub App пользователями. Дополнительные сведения см. в разделе [AUTOTITLE и Установка собственного приложения GitHub](/apps/sharing-github-apps/sharing-your-github-app).

Вы всегда можете вносить изменения в параметры для вашего GitHub App. Дополнительные сведения см. в разделе Изменение регистрации приложения GitHub.