Como criar gatilhos de aplicativos do GitHub

Os gatilhos de aplicativos do GitHub permitem invocar versões automaticamente em solicitações de envio e extração do Git e visualizar os resultados da versão no GitHub e no Console do Cloud. Além disso, os gatilhos de aplicativos do GitHub são compatíveis com todos os recursos compatíveis com os gatilhos existentes do GitHub e usam o aplicativo GitHub do Cloud Build para configurar e autenticar no GitHub.

Esta página explica como criar gatilhos de aplicativos do GitHub.

Como criar gatilhos de aplicativos do GitHub

Nesta seção, explicamos como instalar o aplicativo do GitHub para Cloud Build para conectar seu repositório do GitHub ao projeto do Cloud e criar gatilhos do aplicativo do GitHub.

Como instalar o app Cloud Build

Para instalar o aplicativo Cloud Build e conectar o repositório do GitHub ao projeto do Cloud:

  1. Abra a página Gatilhos no Console do Google Cloud.

    Abrir a página Acionadores

  2. No seletor de projetos, na barra superior, selecione seu projeto do Cloud.

  3. Clique em Conectar repositório.

  4. Selecione GitHub (aplicativo do GitHub para Cloud Build), marque a caixa de seleção de consentimento e clique em Continuar .

  5. (Opcional) Se você não tiver feito login no GitHub, faça isso agora.

    A página "Autorização" é exibida quando você recebe a solicitação para a autorizar o aplicativo do Google Cloud Build a se conectar ao Google Cloud Platform.

    Captura de tela do botão de autorização

    Clique em Autorizar Google Cloud Build por GoogleCloudBuild.

  6. Clique em Instalar o Google Cloud Build .

  7. No pop-up exibido, selecione seu nome de usuário ou organização do GitHub.

  8. Selecione uma das seguintes opções com base na necessidade do seu negócio:

    • Todos os repositórios: ative todos os repositórios atuais e futuros do GitHub para acesso por meio do aplicativo Cloud Build.

    • Selecionar apenas repositórios: use a lista suspensa Selecionar repositórios para ativar apenas repositórios específicos para acesso por meio do aplicativo Cloud Build. Você poderá ativar repositórios adicionais posteriormente.

  9. Clique em Instalar para instalar o aplicativo Cloud Build.

    O pop-up é fechado e você retorna à página Selecionar repositório no Console do Cloud. Nesta página, você conectará seus repositórios do GitHub ao seu projeto do Cloud.

  10. Na página Selecionar repositório exibida, conecte os repositórios do GitHub ao projeto do Cloud da seguinte forma:

    a. Confirme se a conta do GitHub correta foi selecionada. A conta do GitHub precisa ter permissões de administrador nos repositórios do GitHub que você quer conectar.

    b. Marque a caixa de seleção ao lado de cada repositório de destino.

    c. Leia a exoneração de responsabilidade de consentimento e marque a caixa de seleção ao lado para indicar que você aceita os termos apresentados.

    d. Clique em Conectar repositório.

    Se você não encontrar um ou mais repositórios de destino, clique em Editar repositórios no GitHub e repita as etapas acima para ativar outros repositórios no aplicativo Cloud Build.

  11. (Opcional) Para criar acionadores de push para os repositórios a que você quer se conectar, selecione as caixas ao lado de cada repositório de destino e clique em Criar acionadores de push. Caso contrário, clique em Ignorar por enquanto.

    Agora você conectou um ou mais repositórios do GitHub ao seu projeto do Cloud. Você irá para a página Gatilhos no Console do Cloud.

Como criar gatilhos de aplicativos do GitHub

Para criar gatilhos de aplicativos do GitHub:

  1. Abra a página Gatilhos no Console do Google Cloud.

    Abrir a página Acionadores

  2. Selecione o projeto no menu suspenso do seletor na parte superior da página.

  3. Clique em Abrir.

  4. Clique em Criar gatilho.

  5. Preencha as configurações de gatilho a seguir:

    • Nome: insira um nome para o gatilho.

    • Descrição (opcional): insira uma descrição para o gatilho.

    • Evento: selecione o evento de repositório para invocar seu gatilho.

      • Enviar para uma ramificação: defina o gatilho para iniciar um build em confirmações de uma ramificação específica.

      • Enviar nova tag por push: configure o gatilho para iniciar um build em confirmações que contenham uma tag específica.

      • Solicitação de envio (somente aplicativo do GitHub): configure o gatilho para iniciar um build em confirmações para uma solicitação de envio.

    • Origem: selecione o repositório e a ramificação ou tag correspondente para assistir aos eventos.

      • Repositório: na lista de repositórios disponíveis, selecione o repositório que você quer. Para conectar um novo repositório, consulte Como conectar mais repositórios.

      • Ramificação ou Tag: especifique uma expressão regular correspondente ao valor da ramificação ou da tag. Para ver informações sobre a sintaxe aceitável de expressões regulares, consulte Sintaxe de RE2 (em inglês).

      • Controle de comentários: se você selecionou Solicitação de envio (somente aplicativo GitHub) como seu Evento, escolha uma das seguintes opções para controlar se um build será executado automaticamente pelo gatilho:

        • Obrigatório, exceto para proprietários e colaboradores: quando uma solicitação de envio for criada ou atualizada por um proprietário ou colaborador de repositório, os builds são executados automaticamente pelo gatilho. Se um colaborador externo iniciar a ação, os builds serão executadas somente depois que um proprietário ou colaborador comentar a /gcbrun na solicitação de envio.

        • Obrigatório: quando uma solicitação de envio é criada ou atualizada por qualquer colaborador, os builds só serão executados depois que um proprietário ou colaborador comentar /gcbrun na solicitação de envio.

        • Não necessário: quando uma solicitação de envio é criada ou atualizada por qualquer colaborador, os builds são executados automaticamente por gatilhos.

    • Arquivos incluídos (opcional): as alterações que afetam pelo menos um desses arquivos invocarão um build.

    • Arquivos ignorados (opcional): as alterações que afetam somente os arquivos ignorados não invocarão um build.

    • Configuração de build: selecione o arquivo de configuração de build (localizado no repositório do GitHub conectado ao projeto do Cloud) para usar no seu build.

      • Para usar um Dockerfile para sua configuração de build, você precisará especificar o diretório Dockerfile e um nome para a imagem resultante. Depois de fornecer o Dockerfile e o nome da imagem, você verá uma visualização do comando docker build que sua o build executará.

      • Para usar um arquivo na configuração de build, você precisará fornecer o local do arquivo de configuração de build e, se quiser, as variáveis de substituição.

  6. Clique em Criar para salvar o gatilho de compilação.

Para criar acionadores de aplicativos do GitHub usando comandos gcloud, consulte os comandos gcloud para Como criar um gatilho de compilação.

Diferentes tipos de gatilhos com base no GitHub

Se seu código-fonte estiver em GitHub, o Cloud Build fornecerá duas maneiras de invocar builds automaticamente. Esta seção explica e compara os recursos dos dois acionadores com base no GitHub.

  • Acionadores do GitHub: quando você cria um acionador do GitHub, o Cloud Build espelha o repositório do GitHub no Cloud Source Repositories, além de usar o repositório espelhado em todas as operações. É possível criar e gerenciar gatilhos do GitHub usando o Console do Cloud.

  • Acionadores de aplicativos do GitHub: esse tipo de acionador usa o app GitHub para Google Cloud Build para configurar e autenticar no GitHub. Os gatilhos de aplicativos do GitHub permitem iniciar automaticamente os builds de solicitações de push e pull no Git e visualizar os resultados de build no GitHub e no Console do Cloud. É possível criar e gerenciar gatilhos de aplicativos do GitHub usando o Console do Cloud ou a API Cloud Build.

A tabela a seguir compara os recursos dos acionadores do GitHub e dos acionadores de aplicativos do GitHub:

Recurso Acionadores do GitHub Gatilhos de aplicativo do GitHub
Invocar versões em push para o código-fonte Sim Sim
Invocar versões em solicitações de envio Não Sim
Criar gatilho usando o Console do Cloud Sim Sim
Criação de acionador usando a API do Cloud Build Não Sim
Criação de acionador usando o app GitHub para Google Cloud Build Não Sim
Ver o status da versão no Console do Cloud Sim Sim
Exibição do status da compilação no GitHub Não Sim

Compartilhamento de dados

Os acionadores de aplicativos do GitHub enviam dados ao app Cloud Build do GitHub. Os dados enviados ao aplicativo ajudam a identificar gatilhos por nome e ver os resultados da versão no GitHub.

Os dados a seguir são compartilhados entre o Google Cloud e o app GitHub:

  • Nome do acionador

Se você criou gatilhos antes de agosto de 2020, talvez o compartilhamento de dados não esteja ativado para seu projeto. É possível ativar o compartilhamento de dados para todos os gatilhos de aplicativos do GitHub no seu projeto clicando em Ativar na guia de compartilhamento de dados do Cloud Build.

Se as verificações de status necessárias estiverem ativadas para um repositório do GitHub, a ativação do compartilhamento de dados poderá interromper temporariamente as verificações de status. Para ajustar as configurações de verificação de status para procurar seu nome de gatilho, é possível:

  • desativar qualquer verificação necessária específica do Cloud Build no repositório do GitHub;
  • garantir que o compartilhamento de dados esteja ativado no Cloud Build;
  • executar uma nova compilação no Cloud Build que publica o status no seu repositório;
  • reativar verificações de status necessárias, selecionando o nome do gatilho.

A seguir