GitHub

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

Чтобы добавить в задачу ссылку на коммит, укажите ключ задачи в комментарии к коммиту, например: Исправление ошибки TEST-123. Ссылка появится в задаче на вкладке Коммиты. Подробнее читайте в разделе Интеграция с репозиториями.

Вы можете выбрать один из способов интеграции:

  • Настроить вебхук в репозитории — рекомендуем использовать этот способ синхронизации, если вы используете репозиторий GitHub на собственном сервере. Он позволяет быстро синхронизировать данные и отображать новые коммиты в задачах в Трекер.

  • Настроить периодический опрос репозитория — Трекер будет периодически запрашивать информацию о коммитах в репозитории.

    Этот способ синхронизации можно настроить для репозиториев, размещенных онлайн или развернутых на собственном сервере.

При опросе репозитория связи с коммитами могут отображаться в Трекере с задержкой до 10 часов.

Настроить вебхук в репозитории

Синхронизация с помощью вебхука доступна для репозиториев, размещенных на собственных серверах вашей компании.

  1. В Трекере получите URL и токен для настройки вебхука: Как получить URL и токен.

  2. Перейдите на главную страницу вашего репозитория Github.

  3. На панели инструментов справа нажмите Settings.

  4. Нажмите Add webhook.

  5. В поле Payload URL введите значение URL, которое вы скопировали в Трекере.

  6. В поле Secret введите значение токена, которое вы скопировали в Трекере.

  7. Под заголовком Which events would you like to trigger this webhook? выберите опцию Just the push event.

  8. Нажмите Add webhook.

Чтобы проверить, что вебхук работает корректно:

  1. Создайте или выберите существующую задачу в Tracker, в которой вы будете тестировать связь с коммитом.

  2. В вашем репозитории создайте коммит и укажите в его комментарии ключ задачи, например: Исправление ошибки TEST-123.

  3. Убедитесь, что на странице задачи в Tracker на вкладке Коммиты отображается информация о вашем коммите.

Настроить опрос репозитория

Подключить онлайн-репозиторий

Чтобы подключить репозиторий на GitHub к Трекеру:

  1. Получите на GitHub токен для доступа к вашему репозиторию:

    • Авторизуйтесь на GitHub. Если репозиторий прикреплен к GitHub-организации, убедитесь, что у вас есть права администратора.

    • Нажмите фото вашего профиля в правом верхнем углу и выберите Settings.

    • На панели слева выберите Developer settings → Personal access token → Tokens (classic).

    • Нажмите кнопку Generate new token.

    • Придумайте название для токена.

    • Настройте разрешения для токена. Для правильной работы с Трекером необходимо, чтобы опции repo и read:org были включены:

    • Нажмите кнопку Generate token.

    • Скопируйте токен в буфер обмена.

    Значение токена отображается только один раз, сохраните его. Если закрыть страницу, вы больше не сможете его просмотреть.

  2. Убедитесь, что вы авторизованы в Трекере как администратор.

  3. В Трекере на панели слева нажмите →  Администрирование, затем откройте раздел  Репозитории.

  4. Нажмите кнопку Добавить и выберите Репозиторий.

  5. В поле Платформа выберите GitHub.

  6. Для опции Адрес сервера выберите значение github.com.

  7. В поле Репозиторий укажите адрес в формате https://github.com/<логин_владельца_репозитория>/<имя_репозитория> и токен для подключения.

  8. Нажмите кнопку Добавить.

  9. Убедитесь, что статус репозитория отображается в Трекере как Подключен.

Подключить репозиторий на собственном сервере

Перед подключением получите токен для доступа к репозиторию. Подробную инструкцию о том, как получить токен, читайте в документации GitHub.

Чтобы подключить к Трекеру репозиторий на собственном сервере:

  1. Убедитесь, что вы авторизованы в Трекере как администратор.

  2. В Трекере на панели слева нажмите →  Администрирование, затем откройте раздел  Репозитории.

  3. Нажмите кнопку Добавить и выберите Репозиторий.

  4. В поле Платформа выберите тип вашего репозитория.

  5. Для опции Адрес сервера выберите значение Собственный.

  6. В поле Репозиторий укажите адрес репозитория на вашем сервере. Подключение к серверу должно осуществляться по технологии OAuth 2.0.

  7. В поле Токен с платформы укажите токен для подключения к вашему серверу.

  8. Нажмите кнопку Добавить.

  9. Убедитесь, что статус репозиториев отображается в Трекере как Подключен.

Предыдущая
Репозитории
Следующая
GitLab