Gatilhos da Web GitHub

Os gatilhos da Web GitHub são configurados para monitorar eventos em um GitHub repositório ou organização.

Visão geral

Os gatilhos de Web GitHub monitoram eventos específicos em uma organização GitHub ou repositório. Quando os eventos ocorrem na organização ou no repositório, o gatilho inicia o fluxo de trabalho de automação configurado.

Autenticação

Os gatilhos da Web do GitHub usam Tokens de acesso pessoal para autenticação do usuário e não exigem uma conexão OAuth. Para obter mais informações sobre a criação e gerenciamento de tokens de acesso pessoal, consulte Gerenciamento de seus tokens de acesso pessoal. O gatilho da Web do GitHub oferece suporte a tokens de acesso clássicos e refinados. Certifique-se de que os tokens de acesso pessoal sejam válidos.

Você pode armazenar esse token no Credential Vault. Consulte Credenciais e lockers no Credential Vault para obter mais informações sobre o armazenamento e manutenção de credenciais.

Eventos compatíveis

Os gatilhos de Web do GitHub oferecem suporte aos seguintes eventos tanto nos níveis de organização quanto de repositório:

Eventos Descrição
Criar Quando um arquivo, ramificação ou tag é criado.
Bifurcação Quando um repositório é bifurcado.
Comentário do problema Quando um comentário é adicionado a um problema ou a uma solicitação de pull.
Problemas Quando um problema é criado no repositório.
Rótulo Quando um rótulo é adicionado ou removido de um problema ou solicitação de pull.
Solicitação de pull Quando uma solicitação de pull é feita em uma ramificação dentro do repositório.
Revisão da solicitação de pull Quando comentários de revisão são adicionados à solicitação de pull.
Push Quando há um push em uma ramificação do repositório.
Estrela Quando um repositório é marcado com estrela
Assistir Quando a opção de observação está ativada para eventos específicos no repositório.

Pré-requisitos

Certifique-se de que os seguintes pré-requisitos sejam atendidos:

  • Uma licença de Bot Creator ou Citizen Developer.
  • Permissões para Exibir meus bots e ACIONADORES DE EVENTOS.
  • Permissão de Fazer checkin e Fazer checkout para as pastas onde a automação está localizada.
  • Um GitHub Token de acesso pessoal ativo.

Configurações

As seguintes configurações estão disponíveis para os GitHub gatilhos da Web:

Captura de tela do gatilho da Web da organização do GitHub

Captura de tela das configurações do gatilho da Web do repositório do GitHub

Monitorar evento
Selecione um ou mais eventos que o gatilho deve monitorar.
Nome da organização
Insira o nome da organização do GitHub. Esse campo é aplicável apenas para o gatilho da Web da organização do GitHub.
Nome do repositório
Insira o nome do repositório dentro da organização do GitHub. Esse campo é aplicável apenas para o gatilho da Web do repositório do GitHub.
Perfil do usuário
Insira o perfil de usuário do GitHub. Esse campo é aplicável apenas para o gatilho da Web do repositório do GitHub
Selecione o tipo de autenticação
Token de acesso pessoal é o tipo de autenticação padrão. Você pode selecionar os Tokens de acesso pessoal armazenados no Credential Vault usando a opção Escolher em Credencial ou inserir os Tokens de acesso pessoal diretamente na opção String insegura.
Resposta (opcional)
Use a opção Resposta para salvar os dados da resposta do gatilho em uma variável de Registro. Você pode criar uma nova variável ou selecionar uma variável existente para armazenar esses dados de resposta. Os dados de resposta do gatilho capturam as informações do corpo da resposta da carga útil da API do webhook do GitHub em um formato de par chave-valor. Use a chave como um nome na variável de Registro, permitindo que esses dados sirvam como entradas para outras ações dentro da automação.
Os gatilhos da Web do GitHub analisam a carga útil do par chave-valor do webhook usando a notação de ponto (.). Você deve seguir o mesmo formato para construir a expressão para a variável de Registro. Por exemplo, para usar o id do repositório como a expressão, você deve inserir repositório.id como a chave. Para obter mais informações sobre a documentação de carga útil de webhook do GitHub, consulte GitHub webook events and payload.
Depois que a execução do bot é encerrada, o Audit log registra os dados da resposta do gatilho em uma execução de Bot pelo evento de gatilho.