Notificações são maneiras de se comunicar com suas equipes e informá-las sobre o status dos pipelines no Automation Pipelines.

Para enviar notificações quando um pipeline é executado, você pode configurar notificações do Automation Pipelines com base no status de todo o pipeline, estágio ou tarefa.

  • Uma notificação por e-mail envia um e-mail em:
    • Conclusão, espera, falha, cancelamento ou início do pipeline.
    • Conclusão, falha ou início do estágio.
    • Conclusão, espera, falha ou início da tarefa.
  • Uma notificação de tíquete cria um tíquete e o atribui a um membro da equipe em:
    • Falha ou conclusão do pipeline.
    • Falha do estágio.
    • Falha da tarefa.
  • Uma notificação de webhook envia uma solicitação a outro aplicativo em:
    • Falha, conclusão, espera, cancelamento ou início do pipeline.
    • Falha, conclusão ou início do estágio.
    • Falha, conclusão, espera ou início da tarefa.
Por exemplo, você pode configurar uma notificação por e-mail sobre uma tarefa de operação do usuário para obter aprovação em um ponto específico do seu pipeline. Quando o pipeline for executado, essa tarefa enviará um e-mail para a pessoa que deve aprová-la. Se a tarefa Operação do Usuário tiver um tempo limite de expiração definido em dias, horas ou minutos, o usuário necessário deverá aprovar o pipeline antes da expiração da tarefa. Caso contrário, o pipeline falhará conforme esperado.

Para criar um tíquete do Jira quando uma tarefa de pipeline falha, você pode configurar uma notificação. Ou, para enviar uma solicitação a um canal do Slack sobre o status de um pipeline com base no evento de pipeline, você pode configurar uma notificação de webhook.

Você pode usar variáveis em todos os tipos de notificações. Por exemplo, é possível usar ${var} na URL de uma notificação de Webhook.

Pré-requisitos

  • Verifique se um ou mais pipelines foram criados. Veja os casos de uso em Tutoriais para usar o Automation Pipelines.
  • Para enviar notificações por e-mail, confirme se é possível acessar um servidor de e-mail ativo. Para obter ajuda, consulte o administrador.
  • Para criar tíquetes, como um tíquete do Jira, confirme se o endpoint existe. Consulte O que são endpoints no Automation Pipelines.
  • Para enviar uma notificação com base em uma integração, crie uma notificação de webhook. Em seguida, confirme se o webhook foi adicionado e está funcionando. Você pode usar notificações com aplicativos como o Slack, o GitHub ou o GitLab.

Procedimento

  1. Abra um pipeline.
  2. Para criar uma notificação para o status geral do pipeline, ou o status de um estágio ou tarefa:
    Para criar uma notificação para: O que você faz:
    Status do pipeline Clique em uma área em branco na tela do pipeline.
    Status de um estágio Clique em uma área em branco em um estágio do pipeline.
    Status de uma tarefa Clique em uma tarefa em um estágio do pipeline.
  3. Clique na guia Notificações.
  4. Clique em Adicionar, selecione o tipo de notificação e configure os detalhes da notificação.
  5. Para criar uma notificação de Slack quando um pipeline for bem-sucedido, crie uma notificação de webhook.
    1. Selecione Webhook.
    2. Para configurar a notificação do Slack, insira as informações.
    3. Clique em Salvar.
    4. Quando o pipeline é executado, o canal de Slack recebe a notificação sobre o status do pipeline. Por exemplo, os usuários podem ver o seguinte no canal de Slack:
      Pipelines APP [12:01 AM]
      Tested by User1 - Staging Pipeline 'User1-Pipeline', Pipeline ID 'e9b5884d809ce2755728177f70f8a' succeeded
  6. Para criar um tíquete do Jira, configure as informações do tíquete.
    1. Selecione Tíquete.
    2. Para configurar a notificação do Jira, insira as informações.
    3. Clique em Salvar.
      Ao configurar notificações de tíquetes do Jira para falhas de pipeline, você inclui o projeto Jira, o tipo de problema, o responsável e um resumo.

Resultados

Parabéns! Você aprendeu que pode criar vários tipos de notificações em diversas áreas do pipeline no Automation Pipelines.

O que Fazer Depois

Para obter um exemplo detalhado sobre como criar uma notificação, consulte Como criar um tíquete do Jira no Automation Pipelines quando uma tarefa de pipeline falhar.