Configure o gatilho da Web de Repositório do GitHub para acionar uma ação sempre que um evento ocorrer em um repositório. Esse exemplo mostra como criar um Task Bot com o gatilho da Web de Repositório do GitHub para exibir o corpo da solicitação pull em uma caixa de mensagens.

Quando o usuário especificado nas configurações cria uma solicitação pull nesse repositório, o gatilho inicia a ação da Caixa de mensagens configurada.

Pré-requisitos

Certifique-se de cumprir os seguintes requisitos:
  • Licença e permissões mencionadas no Gatilhos da Web GitHub.
  • Um token de acesso pessoal do GitHub ativo armazenado como uma credencial no seu Cofre de credenciais.
  • Uma variável de registro chamada TriggerData.

Procedimento

  1. Execute as seguintes etapas para criar um Task Bot
    1. No painel da esquerda, clique em Automation (Automação).
    2. Clique em Criar > Task Bot.
      O assistente Criar bot de tarefa é exibido.
    3. Digite um nome apropriado para o bot no campo Nome.
      Todos os bots são armazenados na pasta \Bots por padrão.
    4. Opcional: Adicione uma descrição para o bot no campo Descrição.
    5. Opcional: Clique em Escolher e siga as instruções para salvar o bot em uma pasta diferente.
    6. Clique em Criar e editar.
      O bot é criado e a página Editar bot de tarefa é exibida.
  2. Execute as etapas a seguir para adicionar e configurar o gatilho da Web de repositório do GitHub.
    1. Clique em Gatilhos > GitHub e, em seguida, clique duas vezes em Gatilho da Web de repositório para adicionar o gatilho da Web.
    2. Selecione Solicitação pull no menu suspenso Monitorar evento.
    3. Insira o nome do repositório no campo Nome do repositório.
      O gatilho monitora o evento desse repositório.
    4. Insira o nome do perfil do GitHub no campo Perfil do usuário.
      O gatilho ativará a ação subsequente apenas se o usuário com o nome de perfil especificado nesse campo criar ou reabrir uma solicitação pull.
    5. Selecione Token de acesso pessoal > Credencial e clique em Escolher.
    6. Siga as instruções no modal Escolher uma credencial e escolha o Token de acesso pessoal armazenado no Cofre de credenciais.
    7. Selecione TriggerData na lista suspensa Resposta.
      Essa variável de registro captura os dados de resposta do gatilho sobre o evento em que a alteração ocorreu no formato de pares de chave-valor.
  3. Execute as seguintes etapas para adicionar e configurar a ação Caixa de mensagem.
    1. Clique em Ações > Caixa de mensagens e, em seguida, clique duas vezes ou arraste Caixa de mensagem para adicionar a ação.
    2. Digite um título apropriado para a caixa de mensagens em Insira o título da janela da caixa de mensagens.
    3. Digite $TriggerData{pull_request.body}$ em Digite a mensagem a ser exibida.
      A chave $TriggerData{pull_request.body}$ dos dados de resposta do gatilho contém o corpo da solicitação pull como o valor correspondente.
  4. Clique em Salvar para salvar a configuração.
Quando você clica em Executar > Executar com gatilhos, o sistema ativa o gatilho, que começa a monitorar eventos de Solicitação pull no repositório do GitHub especificado. Quando o usuário com o nome de perfil especificado cria ou reabre uma solicitação pull neste repositório, o gatilho inicia a ação Caixa de mensagem. A caixa de mensagens exibe o corpo da solicitação pull.