Jira
Интеграция репозитория Шерлока с Jira позволяет:
- Создавать задачи в Jira из Шерлока;
- Получать информацию из Jira о задачах (статус, исполнитель);
- Синхронизировать комментарии между Шерлоком и Jira.
Подготовительная работа
Перед тем, как интегрировать репозиторий с Jira-проектом необходимо убедиться, что настроена системная интеграция между Шерлоком и Jira.
Создание интеграции
-
Для настройки интеграции репозитория с Jira-проектом необходимо, необходимо, находясь в репозитории, нажать на Меню действий () и выбрать Интеграции.
-
В открывшемся меню найти Jira и нажать Подключить.
-
Заполнить необходимые параметры в открывшемся окне:
- Код проекта: код проекта в Jira.
-
Нажать кнопку Подключить. В случае успеха Шерлок оповестит о том, что подключение настроено и можно продолжать работу.
Если при настройке системной интеграции был использован токен, отличный от административного, Шерлок не сможет зарегистрировать веб-хук самостоятельно и оповестит об этом.
В этом случае, для реализации двусторонней интеграции с Jira, потребуется зарегистрировать веб-хук вручную. Подробнее о том, как это сделать написано в соответствующем разделе.
Изменение интеграции
-
Для изменения интеграции необходимо нажать на иконку редактирования (), расположенную рядом с интеграцией, которую необходимо изменить.
к сведениюНастройки изменения интеграции аналогичны тем, что используются и при ее создании.
-
Нажать кнопку Сохранить после внесения необходимых изменений. В случае успеха Шерлок оповестит о том, что подключение изменено и можно продолжать работу.
Удаление интеграции
-
Для удаления интеграции необходимо нажать на иконку удаления (), расположенную рядом с интеграцией, которую необходимо удалить.
-
В открывшейся форме нажать кнопку Отключить. В случае успеха Шерлок оповестит о том, что подключение удалено и можно продолжать работу.
вниманиеВ случае отключения интеграции с Jira пользователь не сможет создавать задачи и синхронизировать данные между Шерлоком и Jira.
Настройка веб-хуков в Jira
Более точную инструкцию о регистрации веб-хуков можно найти в официальной документации Jira.
-
Для регистрации веб-хука в Jira необходимо перейти в раздел Система -> Веб-хуки и нажать Создать веб-хук.
-
Заполнить необходимые параметры в открывшемся окне:
- Имя: наименование веб-хука;
- URL: адрес, на который будут отправляться сведения об изменении задач;
- Секрет: секрет, используемый для проверки легитимности веб-хука на стороне Шерлока;
- События: информация о том, о каких событиях оповещать:
- События, относящиеся к проблеме: информация о Jira проекте в формате
project = <PROJECT_NAME>; - Проблема: выбор событий о задачах, на которые надо реагировать. Необходимо выбрать Обновлена для Проблема и Удален для Комментарий.
- События, относящиеся к проблеме: информация о Jira проекте в формате
к сведениюИнформацию о URL и Секрете можно получить из Шерлока. Для этого необходимо нажать кнопку Как подключить веб-хук, расположенную рядом с интеграцией в настройках репозитория.
-
Нажать кнопку Создать. В случае успеха Jira оповестит о том, что веб-хук зарегистрирован и можно продолжать работу.
Синхронизация типов задачах
Шерлок позволяет синхронизировать типы задач с Jira-проектом в ручном режиме. Для этого необходимо нажать на иконку синхронизации типов задач (), расположенную рядом с интеграцией.