Перейти к содержанию

Интеграция с Jira


Интеграция с Jira позволяет настроить автоматическую отправку комментария к задаче, если она упоминается в коммите или запросе на слияния. Кроме того, интеграция позволяет автоматически изменять статус упомянутой задачи.

Для создания интеграции можно использовать как локальную версию Jira, так и Jira Cloud.

Создание интеграции с Jira

Для создания интеграции необходимо перейти в настройки проекта в раздел Интеграции и нажать кнопку Создать возле интеграции с Jira.

Создание интеграции с Jira

Установка соединения

  • Укажите URL-адрес веб-страницы, например https://jira.example.com
  • Укажите URL-адрес API Jira, например https://jira-api.example.com Если оставить данное поле пустым, то будет использоваться значение URL-адрес веб-страницы. Оставьте пустым данное поле для Jira Cloud.
  • Выберите метод аутентификации
    • Базовый. Аутентификации с помощью электронной почты или имени пользователя и API-токена или пароля.
    • Токен личного доступа Jira. Токен можно создать в настройках профиля Jira, в разделе Персональные токены доступа

Для проверки установленного соединения есть соответствующая кнопка

Установка соединения

Триггеры

В данном разделе выбираются события - коммит или запрос на слияние, после которых срабатывает интеграция. Для работы интеграции можно упоминать задачу как в виде полной ссылки (например, https://jira.example/browse/GF-1), так и в виде только префикса (например, GF-1). Упоминать задачи в запросе на слияния можно в заголовке или описании. Кроме того, интеграция будет реагировать на изменение статуса запроса на слияние.

Настройка действий - создание комментария или изменение статуса задачи, происходит также здесь.

  • Включить комментарии. Интеграция автоматически создаст комментарий в задаче с описанием события, в котором данная задача была упомянута. Для выбора полноты комментария присутствуют опции Стандартные комментарии и Расширенные комментарии.

  • Переводить задачи Jira в их финальное состояние. Интеграция автоматически переведет статус задачи в финальный после выполнения запроса на слияние, в котором упоминается задача. Для изменения статуса необходимо в описании запроса добавить "Закрывает <задача>". Вместо <задача> необходимо указать номер задачи, подходящий под регулярное выражение, указанное в поле Jira. Для изменения статуса нескольких задач необходимо добавить указанную строку для каждой задачи отдельно. Настройка Использовать пользовательский ID финального состояния позволит указать конкретный ID статуса, если в вашем рабочем процессе Jira финальный статус отличается от Done.

Триггеры

Сопоставление задач в Jira

Для ограничения списка задач, упоминание которых вызовет срабатывание интеграции, необходимо воспользоваться следующими настройками:

  • Регулярное выражение для задач в Jira. Необязательное поле. Сопоставление ключей задач Jira с регулярными выражениями, соответствующие синтаксису RE2. Данное регулярное выражение используется для перевода задач в статус финального состояния (по указанному ранее ID). По умолчанию используется регулярное выражение по ключевым словам Закрыть, Закрывает, Исправить, Исправляет, Closes. Например, слияние Запроса на слияние с фразой в описании Закрывает GF-123 переведет задачу в указанное финальное состояние.

  • Префикс для задач в Jira. Обязательное поле, в котором необходимо указать префикс задач Jira в виде ПРЕФИКС#, упоминание которых в коммитах или запросах на слияние, будет вызывать срабатывание интеграции. Например, GF# будет срабатывать на упоминание задач в виде ... GF-123 и оставлять комментарий об упоминании задачи в GitFlic.

Сопоставление задач в Jira

Ограничение на число интеграций

Максимальное количество интеграций для каждого проекта 1

Пример работы интеграции

Пример работы интеграции