Как использовать приложение GitHub в Google Chat

Приложение GitHub в Google Chat позволяет получать уведомления о событиях GitHub, например о добавлении вопросов, pull-запросах и комментариях.

Подготовка

Чтобы использовать приложение GitHub для Chat:

Для установки приложений требуется получить разрешение администратора Google Workspace.
Добавьте приложение в Chat. Подробнее о том, как находить и добавлять приложения…
У вас должен быть аккаунт GitHub.
Вам нужно установить приложение Google Chat для хранилища GitHub.

Как работают механизмы аутентификации приложений GitHub и OAuth

В этой статье описаны различия в работе приложений GitHub и OAuth как основных механизмов интеграции сторонних сервисов с GitHub и доступа к ресурсам GitHub. Понимание различий необходимо для обеспечения оптимального уровня безопасности в организации.

1. Сравнительный анализ: основные различия

Основное различие между этими моделями заключается в том, какой субъект используется для доступа и какой механизм управляет авторизацией ресурсов.

Атрибут	Приложение GitHub (рекомендуемый способ входа)	Приложение OAuth (устаревший способ входа)
Субъект	Действует от имени независимого субъекта — приложения, а не пользователя.	Действует от имени пользователя, предоставившего разрешение, наследуя его права.
Модель авторизации	Точные разрешения (рекомендуется). Используется принцип минимальных привилегий, позволяющий предоставлять доступ к конкретным хранилищам и типам ресурсов. Например, доступ к метаданным только для чтения.	Широкие области действия. Доступ определяется широкими областями действия, например может быть дан доступ ко всем ресурсам, видимым пользователю, предоставившему разрешение.
Срок действия учетных данных	Токены с ограниченным сроком действия. Срок действия токенов доступа ограничен (обычно одним часом), поэтому их нужно часто обновлять. Это значительно снижает риск в случае компрометации.	Долгосрочные токены. Токены доступа действуют, пока пользователь не отзовет их вручную, что представляет собой риск в долгосрочной перспективе.
Требования к установке	Должно быть установлено администратором или владельцем организации, чтобы установить официальную связь с аккаунтом или организацией. Пользователь должен предоставить приложению разрешение на выполнение действий от его имени.	Должно быть авторизовано конкретным пользователем, чтобы связать доступ непосредственно с ним.

Более подробную информацию можно найти в статье Различия между приложениями GitHub и приложениями OAuth.

2. Рекомендация

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

Установите приложение Google Chat для хранилищ GitHub.

Как настроить приложение GitHub в Chat

Откройте Chat.
Откройте прямую переписку с приложением или чат-группу с ним.
Чтобы открыть окно настройки, нажмите Войти.
Нажмите Настроить доступ Войти в GitHub.
Выполните вход и закройте всплывающее окно.
Чтобы обновить диалоговое окно Chat, нажмите Обновить.
В разделе Добавить репозитории укажите репозиторий GitHub, для которого хотите получать уведомления.
Установите флажки для событий, о которых хотите получать уведомления.
Нажмите Сохранить.

Примечание. Уведомления необходимо настраивать отдельно в каждой чат-группе, где есть приложение. Приложение отправляет сообщения во все группы, участником которых является.

Как перейти с приложения OAuth (устаревшая версия) на приложение GitHub (рекомендуется)

Чтобы перейти для подключения со старого метода аутентификации через приложение OAuth на рекомендуемый метод приложения GitHub:

Откройте Chat.
Откройте прямую переписку или чат-группу с приложением GitHub.
В поле сообщения нажмите "Инструменты Google Workspace" .
В списке команд выберите GitHub Reauthorize (Повторно авторизовать GitHub).
Чтобы завершить переход и повторно авторизоваться, следуйте инструкциям на экране в диалоговом окне Chat.

Как использовать приложение GitHub в чат-группах

Чтобы взаимодействовать с приложением в чат-группе, необходимо @упоминать (или /упоминать) его в каждом сообщении и в ответах на сообщения от него.

@упоминание или /упоминание указывает, что сообщение предназначено приложению, а не другим участникам группы.

Откройте приложение Chat .
В чат-группе введите @github или /github и команду.
- Когда вы вводите @github или /github, сообщение отправляется приложению, а не другим пользователям в группе.

Как менять настройки приложения

В чат-группах менять настройки приложения может только тот, кто его добавил.

Откройте Chat.
Откройте прямую переписку с приложением или чат-группу с ним.
Чтобы открыть настройки приложения, введите /github_settings.
Задайте нужные настройки.
Нажмите Сохранить.

Если вы удалите приложение из чат-группы, все его настройки также будут удалены.

О командах для приложения GitHub в Chat

В чате или чат-группе с приложением GitHub в Chat можно использовать следующие варианты.

Слеш-команды.
- /github_settings – открывает диалоговое окно настроек.
- /github_reminders – для отдельных пользователей и команд открывает pull-запросы, позволяет устанавливать и редактировать напоминания.
- /github_subscribe – включает подписку на <repoURL> или <owner/repo> GitHub.
- /github_openIssue – создает новый элемент в GitHub.
- /github_logout – выход из аккаунта GitHub.
- /github_help – отображает сообщение справки.
- /github_feedback – отправляет отзыв о приложении GitHub.
Быстрые команды. Чтобы открыть быстрые команды, нажмите на инструменты Google Workspace .
- GitHub Connect (Подключение к GitHub). Показывает сообщение с вариантами "Sign in (Войти)" и "Legacy Sign in (Войти в устаревшую версию)".
- GitHub Reauthorize (Повторная авторизация GitHub). Позволяет перейти на новый способ подключения.

Как открыть полный список команд

На компьютере откройте Chat.
Начните прямую переписку или откройте чат-группу, где установлено приложение GitHub.
Введите /github_help.

Устранение неполадок с приложением GitHub в Chat

Если вы получили сообщение об ошибке после подписки на уведомления в режиме реального времени

Приложение GitHub

Чтобы настроить уведомления в режиме реального времени в чат-группах:

В браузере откройте настройки профиля GitHub.
В разделе Integrations (Интеграции) нажмите Applications (Приложения) Authorized GitHub apps (Авторизованные приложения GitHub).
- После того как вы включите приложение GitHub в Google Chat, в списке авторизованных приложений будет Google Chat.
Установите приложение Google Chat для хранилища GitHub.
- Вы также можете запросить установку у владельца организации или хранилища.
Дождитесь завершения установки.
В Google Chat откройте прямую переписку или чат-группу с приложением GitHub.
В поле сообщения, чтобы создать подписку, введите /github_subscribe [организация или хранилище] либо /github_settings.

Приложение OAuth

Требования для настройки уведомлений в режиме реального времени в чат-группах

Вы должны быть владельцем выбранного репозитория в организации.
Необходимо разрешить приложение в организации GitHub.
1. В браузере откройте настройки профиля GitHub.
2. В разделе Integrations (Интеграции) нажмите Applications (Приложения) Authorized OAuth apps (Авторизованные приложения OAuth).
  - После того как вы включите приложение GitHub в Google Chat, в списке авторизованных приложений будет Google Chat.
3. Предоставьте приложению доступ к нужной организации.

Если вы получаете слишком много уведомлений от приложения GitHub

В поле сообщения введите /github_settings.
Чтобы изменить настройки уведомлений для хранилища, нажмите Notification settings (Настройки уведомлений).
Чтобы фильтровать уведомления, рядом с каждым типом уведомлений нажмите стрелку вниз .
- Будут показаны параметры фильтрации уведомлений.
Установите флажки для уведомлений, которые хотите получать.
Нажмите Сохранить.

Если вы не @упоминаетесь в напоминаниях

Чтобы вы упоминались в напоминаниях, необходимо связать аккаунт Google Chat с аккаунтом GitHub.

В поле сообщения введите /github_settings.
Чтобы связать аккаунт, выполните следующие действия:
1. Во всплывающем окне нажмите Configure access (Настроить доступ) Sign in to GitHub (Войти в GitHub).
2. Войдите в аккаунт GitHub.
3. Авторизуйте приложение.
В сообщении, полученном от приложения GitHub, выберите Schedule reminders for your team (Установить напоминания для команды).
Во всплывающем окне:
1. Нажмите Create new reminder (Создать напоминание).
2. Настройте напоминание.
3. Нажмите Сохранить.

Если вы не получаете напоминания от приложения GitHub

В хранилище, для которого вы хотите получать напоминания, проверьте, установлено ли приложение Google Chat для GitHub.

_{Google, Google Workspace, а также другие связанные знаки и логотипы являются товарными знаками компании Google LLC. Все другие названия компаний и продуктов являются товарными знаками соответствующих компаний.}