PanDev Metrics имеет возможность интеграции с системами контроля версий Git. В данной статье пойдет речь о том, как настроить автоматический трекинг веток в GitLab, и что он из себя представляет.
¶ Интеграция PanDev Metrics с GitLab предоставляет две ключевые возможности:
¶ 1. Повышение эффективности код-ревью
Интеграция PanDev Metrics с GitLab предоставляет детальную информацию о временных затратах на разработку: сколько времени было потрачено на работу в ветке, на конкретных файлах, а также данные о днях и часах активности. Эти сведения помогают глубже анализировать сложность задачи, объективно оценивать вклад разработчика и его продуктивность, а также находить потенциальные узкие места в процессе разработки.
Ниже представлен пример заметки, которую оставляет PanDev Metrics при создании запроса на слияние рабочей ветки в dev ветку в GitLab.
Как видно на данном скриншоте PanDev Metrics предоставляет подробную информацию о времени, затраченном на разработку, в том числе сколько заняла разработка всего, сколько дней велась активная разработка, список самых трудозатратных файлов, который поможет понять, на какие участки кода стоит обратить внимание в первую очередь.
При добавлении коммитов к уже созданному merge request заметка будет обновляться и пополняться актуальной информацией.
¶ 2. Фильтрация проектов
Интеграция PanDev Metrics с GitLab позволяет отделять рабочую активность разработчиков в корпоративных проектах от их участия в сторонних или личных проектах. Это помогает сосредоточиться исключительно на результатах, относящихся к проектам компании, и значительно повышает точность оценки продуктивности каждого участника команды.
¶ Пошаговое руководство по интеграции PanDev Metrics с GitLab
В данном разделе приведено пошаговое руководство по настройке интеграции PanDev Metrics с GitLab.
¶ Шаг 1: Создание учетной записи, от имени которой будут публиковаться заметки к мерж реквестам
Крайне рекомендуется создать отдельную сущность/учетную запись, от имени которой будут публиковаться заметки к мерж реквестам. Для GitLab Cloud необходимо использовать существующую учетную запись с необходимыми правами.
¶ Если используете GitLab Cloud, то можно создать учетную запись таким же путем, каким создается обычная учетная запись пользователя и добавить ее во все группы проектов.
Процесс создания сущности:
- Убедитесь, что у вас есть права администратора в GitLab.
Если они у вас есть, то в левом нижнем углу вы увидите кнопку примерно такого вида:
- Нажав на эту кнопку вы перейдете в пространство администратора, в котором сможете создать нового пользователя при помощи данной кнопки:
- Заполните необходимые поля и создайте пользователя с правами администратора. Права администратора требуются для того, чтобы у данного пользователя был доступ ко всем проектам в репозитории и право оставлять комментарии и редактировать их. А также для того, чтобы этот пользователь мог получать email сотрудника создавшего MR.
¶ Шаг 2: Получение персонального токена
- Выпустите для него созданной учетной записи токен с правами(scopes)
apiнажав на кнопку
Данный токен будет использован для генерации заметок с информацией для аналитики под запросами на слияние рабочей ветки в основную ветку разработки.
Вот примерный вид результата выпуска персонального токена:
Будьте внимательны! Токен можно просмотреть/скопировать только один раз!
¶ Шаг 3a: Настройка вебхуков для GitLab on-premise
Для полноценной интеграции PanDev Metrics с GitLab необходимо настроить вебхуки, которые позволят серверу метрик понимать, когда в GitLab происходят события, связанные с репозиториями и слиянием веток.
- Перейдите в пространство администратора нажав кнопку
- В открывшемся пространстве слева будет кнопка, где можно будет добавить вебхук
- Далее нажмите кнопку добавления нового вебхука
- Добавьте вебхук с отмеченным чекбоксом
Repository update events, для этого введите в URLhttps://<url вашего сервера метрик>/v1/gitlab/webhook/repository
- Добавьте вебхук с отмеченным чекбоксом
Merge request events, для этого введите в URLhttps://<url вашего сервера метрик>/v1/gitlab/webhook/merge-request
- Добавьте вебхук с отмеченным чекбоксом
Push events, для этого введите в URLhttps://<url вашего сервера метрик>/v1/gitlab/webhook/push
¶ Шаг 3b: Настройка вебхуков для GitLab Cloud
Для полноценной интеграции PanDev Metrics с GitLab Cloud необходимо настроить вебхуки для каждой группы проектов, это позволит серверу метрик понимать, когда в GitLab происходят события, связанные с репозиториями и слиянием веток.
- Перейдите в целевую группу, для которой настраиваются вебхуки
- Перейдите в настройки вебхуков
- Создайте два вебхука со следующими настройками:
Repository Events Webhook
https://<url вашего сервера метрик>/v1/gitlab/webhook/repository
Push events Tag push events SSL Verification: enabled
Merge Request Webhook
https://<url вашего сервера метрик>/v1/gitlab/webhook/merge-request
Merge request events SSL Verification: enabled
