Главная / Документация / GitLab и GitHub

Подключение GitLab и GitHub

Подключение нужно, чтобы создавать проекты из репозиториев, опрашивать ветки и публиковать находки ревью в merge request. Запросы к форджу идут от имени пользователя, который выполнил подключение.

Токены

Токены хранятся зашифрованно, выдаются по требованию, повторно не показываются и не передаются модели. Сохранённое значение можно заменить, но не посмотреть.

GitLab

Одно OAuth-приложение на пользователя. Список проектов, опрос веток и открытие merge request выполняются от его имени.

Что понадобится: право создать OAuth-приложение в вашем GitLab (Settings → Applications) и адрес сервера GitLab.

  1. Откройте меню учётной записи → Git Forges, карточку 01 GitLab, блок your application.
  2. Создайте приложение в GitLab с redirect и scopes ровно такими, как показывает форма: api read_repository write_repository. Redirect строится от адреса установки и на новой установке может указывать на localhost — сверьте его с адресом, по которому пользователи открывают Council, и при необходимости исправьте адрес установки до регистрации.
  3. Заполните в форме gitlab url, application id и secret и сохраните.
  4. Нажмите кнопку подключения и завершите авторизацию в GitLab.

Действия на карточке: TEST CONNECTION проверяет подключение, REPLACE APP заменяет приложение, REMOVE APP удаляет его, DISCONNECT отзывает токен. Проекты, созданные из форджа, после отключения остаются, но новые коммиты в них больше не приходят.

GitHub

На установку Council одна GitHub App, её регистрирует администратор. Каждый пользователь устанавливает приложение на свои аккаунты и организации.

Регистрация приложения (администратор)

  1. Создайте GitHub App: Settings → Developer settings → GitHub Apps → New GitHub App. Укажите HOMEPAGE URL, CALLBACK URL и SETUP URL с отметкой «Redirect on update» — значения показаны на карточке. «Request user authorization (OAuth) during installation» и Webhook выключите.
  2. Заполните в Council app id и private key (pem).
  3. Сохраните и нажмите TEST CONNECTION.

Установка приложения (каждый пользователь)

  1. Нажмите + ADD на карточке 02 GitHub.
  2. Установите приложение в GitHub на нужный аккаунт или организацию.
  3. Завершите установку переходом по Setup URL обратно в Council.

Если что-то не работает

Сообщение или симптомПричина и действие
The redirect URI included is not validRedirect в приложении GitLab отличается от показанного в форме. Сверяйте приложение по Application ID, а не по имени.
Установка GitHub не появилась в спискеУстановка фиксируется только при возврате по Setup URL. Установите приложение снова и дождитесь перехода назад.
Фордж подключён, репозитории не видныУ приложения не хватает scopes из формы регистрации. Исправьте приложение и повторите TEST CONNECTION.
GitHub отклоняет сохранённое значениеСохранён не тот тип значения: нужен private key приложения, а не personal access token и не client secret.

Дальше: Проекты