С интеграцией GitLab вы видите merge requests, пайплайны, окружения и коммиты прямо в задачах FeatValue. Клиенты простыми словами узнают, находится ли их изменение в работе, на staging для проверки или уже опубликовано.
Для чего нужна интеграция с GitLab
Разработчики ПО и веб-агентства постоянно слышат один и тот же вопрос: «Это уже онлайн?» С интеграцией FeatValue отвечает на него прямо в задаче:
- Ветки, коммиты и merge requests с идентификатором задачи появляются в соответствующей задаче.
- Пайплайны и развёртывания показывают, протестировано ли изменение и в какое окружение оно попало.
- FeatValue записывает важные шаги комментариями в историю задачи.
- Для каждого проекта вы решаете, что из этого видят клиенты.
- Ручные задания, например развёртывание, вы запускаете прямо из FeatValue.
Обзор вы найдёте на странице об интеграции с GitLab.
Требования
- аккаунт FeatValue вашей компании хотя бы с одним клиентом и проектом (см. Создание проектов)
- GitLab на gitlab.com или собственный экземпляр, доступный по https
- как минимум роль Maintainer в проектах GitLab, которые вы хотите связать. Она позволяет FeatValue создать вебхук.
Подключить GitLab
-
Откройте приложение
Нажмите в левой боковой панели
Приложения, выберите
GitLab и нажмите
Установить (см.
Подключение приложений). Откроется страница
Подключить GitLab с вопросом
Где находится ваш GitLab?
-
gitlab.com
Выберите gitlab.com и нажмите Далее. Войдите в GitLab и разрешите доступ. Так FeatValue получит доступ к вашим проектам.
-
Собственный экземпляр GitLab
Выберите Собственный экземпляр GitLab. Укажите адрес https в поле Адрес экземпляра, например https://gitlab.example.com, и токен в поле Personal access token. Нажмите Далее.
Какой токен нужен для собственного экземпляра?
Создайте токен в GitLab в разделе Настройки › Access tokens:
- Область (scope):
api. Областей только для чтения, например read_api, недостаточно, потому что FeatValue создаёт вебхуки и запускает ручные задания.
- Роль: пользователю токена нужна в проектах как минимум роль Maintainer.
- Срок действия: когда срок действия токена истекает, новые данные перестают поступать. Создайте новый токен и снова подключите GitLab.
Лучше всего используйте для интеграции отдельного пользователя или токен группы. Тогда она не зависит от аккаунта одного человека.
Связать репозиторий с проектом
Каждый репозиторий относится ровно к одному проекту FeatValue. В FeatValue попадают только связанные репозитории.
-
Откройте «Связать репозитории»
Откройте
Настройки › Компания › Интеграции и приложения и выберите
GitLab (см.
Подключённые приложения). Страница называется
Связать репозитории.
-
Найдите репозиторий
Ваши репозитории перечислены в разделе Репозитории в GitLab. С помощью Найти репозиторий вы сужаете список.
-
Выберите проект и свяжите
Рядом с репозиторием выберите Проект FeatValue и нажмите Связать. FeatValue создаёт вебхук в GitLab и подгружает данные за последние несколько дней.
Все связи перечислены в разделе Связанные репозитории. В столбце Обновление указано Сразу через вебхук или Каждые 10 минут. Кнопка Изменить позволяет выбрать другой проект, а Отвязать удаляет связь; FeatValue при этом снова удаляет вебхук.
Как правильно использовать идентификатор задачи
У каждой задачи в FeatValue есть идентификатор, например abc123-4. Вы найдёте его в задаче. Укажите этот идентификатор в одном из этих мест:
| Где |
Пример |
| Название ветки |
abc123-4-contact-form |
| Сообщение коммита |
abc123-4 Сделать телефон обязательным |
| Заголовок или описание merge request |
Контактная форма: телефон обязателен (abc123-4) |
- Регистр букв не важен, допускается
# в начале.
- Если идентификатор стоит в названии ветки, учитываются только коммиты, которые есть исключительно в этой ветке. Коммиты из основной ветки, попавшие в неё при ответвлении, в задаче не появляются.
- Коммиты в других ветках появляются, только если идентификатор есть в их сообщении коммита.
- Идентификатор действует только внутри связанного проекта. Репозитории, связанные с другим проектом или не связанные вовсе, FeatValue никогда не привязывает.
- Пайплайны и развёртывания относятся к задаче, если они запущены для одной из её веток, её коммитов или merge requests.
Что появляется в задаче
В задаче есть раздел Разработка с одной компактной строкой, например: MR !12 слит · Пайплайн успешен · Развёрнуто на Staging. Нажмите Показать подробности, чтобы развернуть:
- Пайплайны с этапами, заданиями и их статусом
- Окружения со ссылкой для открытия, например Staging и Production
- Merge requests, Ветки и Коммиты
Что появляется в проекте
В проекте раздел Разработка показывает окружения с последним развёртыванием и последний пайплайн основной ветки. Нажмите Показать все пайплайны, чтобы увидеть Последние пайплайны. Здесь же находятся Настройки проекта.
Что видят клиенты?
В Настройках раздела Разработка в проекте выберите в пункте Что видят клиенты?:
| Настройка |
Ваш клиент видит |
| Ничего |
никакой информации из GitLab |
| Простой статус |
одно предложение без технических терминов: В работе, Развёрнуто на Staging со ссылкой протестировать здесь или Опубликовано со ссылкой посмотреть |
| Подробности |
разделы, отмеченные в пункте Подробности для клиентов: коммиты, ветки, merge requests, пайплайны, окружения и комментарии истории |
Эту настройку могут менять сотрудники вашей компании, которым разрешено редактировать проект. Как клиент затем тестирует и принимает задачу, описано в разделе Ревью и приёмка.
Настройка комментариев в истории
FeatValue записывает важные шаги комментариями в историю задачи. В пункте Комментарии истории в задаче вы выбираете для каждого проекта, какие события создают комментарий:
- Merge request слит
- Пайплайн успешен
- Пайплайн завершился ошибкой (с упавшими джобами)
- Развёрнуто в окружении
Отключённые события по-прежнему обновляют статус в задаче, но больше не создают комментарий. Видит ли клиент комментарии, зависит от настройки в пункте Что видят клиенты?.
Запуск заданий из FeatValue
Starter
Ручные задания вашего пайплайна, например deploy-production, вы запускаете прямо в FeatValue. Это доступно начиная с тарифа Starter (см. Тарифы).
-
Разрешите задания
В проекте откройте Настройки раздела Разработка. В пункте Запуск заданий из FeatValue перечислены ручные задания, о которых GitLab уже сообщил. Отметьте задания, которые должны появляться в FeatValue, и нажмите Сохранить.
-
Также для клиентов
Если клиент тоже должен иметь возможность запускать выбранные задания, отметьте Клиенты тоже могут запускать выбранные задания.
-
Запустите задание
Когда разрешённое задание ждёт ручного запуска, оно появляется с кнопкой Запустить. После нажатия FeatValue показывает Запущено, а дальнейший ход вы отслеживаете в пайплайне.
Если там написано Ручные задания пока не поступали., значит, ещё не запускался ни один пайплайн с ручным заданием. Как только GitLab сообщит о нём, вы сможете его разрешить.
Безопасность
- Только связанные репозитории: FeatValue читает только репозитории, которые вы связали с проектом, и привязывает идентификаторы задач только внутри этого проекта.
- Без кода: FeatValue не хранит файлы из вашего репозитория, только сведения о ветках, коммитах, merge requests, пайплайнах и окружениях.
- Проверенный вебхук: каждый вебхук получает собственный секретный токен. FeatValue принимает только вызовы, которые передают этот токен.
- Ваши права в GitLab: FeatValue работает с правами входа или токена. Он может запускать только задания, которые вы разрешили.
- Отвязать в любой момент: Отвязать удаляет связь, и FeatValue удаляет вебхук.
Устранение неполадок
Моего репозитория нет в списке
FeatValue показывает только репозитории, в которых у вас есть как минимум роль Maintainer. Проверьте свою роль в GitLab или найдите репозиторий по названию через Найти репозиторий.
Не удалось создать вебхук
Тогда у связи указано Каждые 10 минут вместо Сразу через вебхук. В этом случае FeatValue проверяет GitLab каждые 10 минут, поэтому ничего не теряется, данные просто приходят позже. Частые причины: у вас нет роли Maintainer или ваш экземпляр GitLab не может отправлять запросы в интернет. Проверьте это, затем нажмите Изменить и снова Связать.
В задаче ничего не появляется
- Связан ли репозиторий с проектом, к которому относится задача?
- Указан ли полный идентификатор задачи в названии ветки, сообщении коммита или merge request?
- Без вебхука новые данные приходят с задержкой до 10 минут.
GitLab не принял токен
Проверьте адрес экземпляра, токен и область api. Токен не должен быть просрочен.
Задание не запускается
Запуск заданий доступен начиная с тарифа Starter. Кроме того, задание должно быть разрешено в настройках проекта и как раз ждать ручного запуска. Если появляется Не удалось запустить, проверьте в GitLab, может ли вход по-прежнему запускать это задание.