GitLab
Включает плагин интеграции с Gitlab.
Настройка
Плагин поддерживает как облачные (SaaS), так и локальные версии GitLab.
Регистрация OAuth приложения в GitLab
Системный администратор Time должен выполнить следующие шаги в GitLab:
- Перейти по адресу
https://gitlab.com/-/profile/applications
илиhttps://gitlab.YOURDOMAIN.com/-/profile/applications
, гдеYOURDOMAIN
- домен вашего GitLab. - Создать новое приложение.
- Установить следующие значения:
- Name - имя вашего приложения в GitLab
- Redirect URI -
https://YOUR-TIME-URL.COM/plugins/com.github.manland.mattermost-plugin-gitlab/oauth/complete
- Выберите
api
иread_user
вScopes
- Сохраните изменения. Скопируйте
Application ID
иSecret
на появившимся экране.
Настройка Time
Системный администратор Time должен выполнить следующие шаги в системной консоли Time, в настройках плагина:
-
Введите GitLab URL, GitLab OAuth Client ID и GitLab OAuth Client Secret, которые вы получили при регистрации OAuth приложения в GitLab.
-
Создайте Webhook Secret и At Rest Encryption Key выбрав
Regenerate
-
(Необязательно) GitLab Group - ограничьте интеграцию одной группой GitLab.
-
(Необязательно) Enable Private Repositories - включите возможность работы с приватными репозиториями.
Пользователи, которых затронет включение частных репозиториев, получат уведомление и должны будут повторно подключиться к своим учетным записям GitLab, чтобы получить доступ к приватным репозиториям.
Использование
Пользователи, которые хотят использовать возможности интеграции GitLab, должны зарегистрировать приложение OAuth в GitLab для Time, а затем подключить учётную запись GitLab к Time.
После подключения вы будете получать прямые сообщения от бота GitLab в Time, когда кто-то упоминает вас, запрашивает отзыв, комментирует или изменяет один из ваших запросов на слияние/проблем или назначает вас ответственным за проблему в GitLab.
Подключение учетной записи в GitLab к Time
Чтобы связать свою учётную запись Time с учётной записью GitLab, используйте команду /gitlab connect
в любом канале Time.
Отключите учётную запись GitLab, выполнив команду /gitlab disconnect
. Выполните команду /gitlab me
, чтобы узнать, какая учётная запись подключена к GitLab.
После подключения выполните команду /gitlab help
, чтобы посмотреть, что вы можете сделать.
Начало работы
Выполните команду /gitlab todo
, чтобы получить список to-do, назначенных задач, назначенных запросов на слияние и запросов на слияние, ожидающих вашего рассмотрения. В качестве альтернативы используйте опции, расположенные на левой боковой панели.
Выполните команду с косой чертой /gitlab webhook
, чтобы GitLab отправлял события в Time. Например: /gitlab webhook add group[/project]
Подписки на канал
Запустите /gitlab subscriptions list
, чтобы просмотреть все ваши подписки.
Чтобы подписаться на канал Time и получать сообщения о новых запросах на слияние, проблемах или других функциях проекта GitLab, выполните команду /gitlab subscriptions add group[/project] [features]
. Чтобы отписаться и перестать получать сообщения, выполните команду /gitlab subscriptions delete group[/project]
.
Для каждого проекта, по которому вы хотите получать уведомления или на который хотите подписаться, создайте веб-хук в канале, где вы хотите отслеживать события, отправляемые из GitLab, с помощью команды /gitlab webhook slash
. Например: /gitlab webhook add group[/project]
Для версий GitLab до версии 1.2:
- В GitLab перейдите к проекту, на который вы хотите подписаться, и выберите Settings → Integrations на боковой панели.
- Установите следующие значения:
- URL —
https://YOUR-TIME-URL.COM/plugins/com.github.manland.mattermost-plugin-gitlab/webhook
- Secret Token — скопируйте токен веб-хука, который вы сгенерировали ранее.
- Выберите все события в Triggers.
- Добавьте веб-хук.
- URL —
Обновление настроек
Чтобы обновить настройки, выполните команду /gitlab settings [setting] [value]
:
- Включайте или выключайте персональные уведомления.
- Включайте или выключайте уведомления при ежедневном первоначальном подключении.