Отправка уведомлений о работе конвейера в службу Code Stream

Уведомления позволяют обмениваться данными с рабочими группами и сообщать им состояние конвейеров в службе Code Stream.

Можно настроить отправку уведомлений Code Stream во время работы конвейера в зависимости от состояния конвейера, этапа или задачи в целом.

• Уведомление по электронной почте отправляется в следующих случаях.
  • Завершение, ожидание, сбой, отмена или запуск конвейера.
  • Завершение, сбой или запуск этапа.
  • Завершение, ожидание, сбой или запуск задачи.
• Уведомление о запросе создает запрос в службу поддержки и назначает его участнику рабочей группы в следующих случаях.
  • Сбой или завершение конвейера.
  • Сбой этапа.
  • Сбой задачи.
• Уведомление с веб-перехватчиком отправляет запрос в другое приложение в следующих случаях.
  • Сбой, завершение, ожидание, отмена или запуск конвейера.
  • Сбой, завершение или запуск этапа.
  • Сбой, завершение, ожидание или запуск задачи.

Например, можно настроить отправку уведомления по электронной почте, относящегося к задаче, связанной с пользовательскими операциями, чтобы получить подтверждение на определенном этапе выполнения конвейера. При выполнении конвейера эта задача отправляет сообщение электронной почты пользователю, который должен подтвердить задачу. Если срок действия задачи «Пользовательская операция» задан в днях, часах или минутах, пользователь должен одобрить конвейер до его истечения. В противном случае работа контейнера ожидаемо завершается сбоем.

Для создания запроса в службу Jira при сбое задачи конвейера можно настроить соответствующее уведомление. Кроме того, для отправки запросов о состоянии конвейера в канал Slack, в зависимости от события конвейера, можно настроить уведомление с веб-перехватчиком.

Во всех типах уведомлений можно использовать переменные. Например, в URL-адресе уведомления с веб-перехватчиком можно использовать переменную ${var}.

Необходимые условия

• Убедитесь в наличии нескольких конвейеров. Примеры использования см. в разделе Учебники по использованию Code Stream.
• Чтобы отправлять уведомления по электронной почте, убедитесь в наличии доступа к работоспособному почтовому серверу. Для получения справки обратитесь к администратору.
• Чтобы создавать запросы в службу поддержки, например запросы Jira, убедитесь в наличии конечной точки. См. раздел Что такое конечные точки в Code Stream.
• Чтобы отправить уведомление на основе интеграции, создайте уведомление с веб-перехватчиком. Затем убедитесь, что веб-перехватчик добавлен и работает. Уведомления можно использовать с такими приложениями, как Slack, GitHub или GitLab.

Процедура

1. Откройте конвейер.
2. Создание уведомлений по общему состоянию выполнения конвейера либо состоянию выполнения этапа или задачи:

   Состояния, при которых создается уведомление:	Действия:
   Состояние выполнения конвейера	Щелкните пустую область в рабочем окне конвейера.
   Состояние выполнения этапа	Щелкните пустую область в этапе конвейера.
   Состояние выполнения задачи	Щелкните задачу в этапе конвейера.

3. Откройте вкладку Уведомления.
4. Нажмите Добавить, выберите тип уведомления и введите подробные сведения об уведомлении.
5. Чтобы настроить отправку уведомления для Slack при успешном выполнении конвейера, создайте уведомление с веб-перехватчиком.
   1. а. Нажмите Веб-перехватчик.
   2. б. Чтобы настроить уведомление Slack, введите следующую информацию.
   3. в. Нажмите Сохранить.
   4. г. В ходе выполнения конвейера в канал Slack отправляются уведомления о состоянии конвейера. Например, сообщения в канале Slack могут выглядеть следующим образом:

      Codestream APP [12:01 AM]
      Tested by User1 - Staging Pipeline 'User1-Pipeline', Pipeline ID 'e9b5884d809ce2755728177f70f8a' succeeded

6. Чтобы создать запрос Jira, введите сведения о запросе.
   1. а. Нажмите Запрос.
   2. б. Чтобы настроить уведомление Jira, введите информацию.
   3. в. Нажмите Сохранить.
      

Результаты

Поздравляем! Вы узнали о том, как создавать различные типы уведомлений для разных областей конвейера в службе Code Stream.

Дальнейшие действия

Подробный пример создания уведомлений см. в разделе Создание запроса Jira в Code Stream при неудачном выполнении задачи конвейера.