Conectar-se ao GitHub

Esta página descreve como criar conexões com o GitHub e links para repositórios do GitHub. Você pode concluir essas tarefas usando o Google Cloud console, ou a Google Cloud CLI.

Estas instruções são para desenvolvedores de aplicativos, administradores de plataformas e gerentes de segurança que querem usar repositórios de código-fonte do GitHub com o Google.

Por exemplo, você pode receber sugestões de programação do Gemini Code Assist, personalizadas para sua base de código, ou usar seus repositórios do GitHub vinculados para desenvolver apps da Web com Firebase App Hosting.

Para saber mais sobre o Developer Connect, consulte Visão geral do Developer Connect.

Antes de começar

  1. Faça login na sua Conta do Google.

    Se você ainda não tiver uma, inscreva-se agora.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Developer Connect API.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

    8.

    Ativar o Developer Connect também ativa a API Secret Manager.

  8. Verifique se você tem acesso a uma conta no GitHub.

    Para manter o trabalho da sua equipe seguro, recomendamos que você conclua as tarefas neste guia usando uma conta de bot ou uma conta compartilhada pela equipe, não uma conta pessoal.

  9. Verifique se você é proprietário de um repositório do GitHub ou se tem permissões de administrador em um repositório compartilhado.
  10. Opcional: crie uma chave de criptografia gerenciada pelo cliente (CMEK) para criptografar os secrets de autenticação criados pelo Developer Connect.
  11. Opcional: para usar as instruções de linha de comando neste guia, siga estas etapas:
    1. Instale a Google Cloud CLI. Se você já instalou a CLI gcloud, verifique se tem a versão mais recente disponível executando gcloud components update.
    2. Crie uma conta de serviço do Developer Connect executando o comando a seguir, em que PROJECT_ID é o Google Cloud ID do projeto: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Funções exigidas

Para conseguir as permissões necessárias para criar conexões e links, peça ao administrador para conceder a você os papéis do IAM a seguir:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando personalizados papéis ou outros predefinidos papéis.

Crie uma conexão

Esta seção descreve como criar uma conexão entre o Developer Connect e o GitHub. Se você estiver usando o Google Cloud console, também poderá começar a adicionar links a repositórios ao terminar de configurar a conexão.

Para criar uma nova conexão do GitHub, selecione uma das seguintes opções:

Console

Inicie uma conexão seguindo estas etapas:

  1. No Google Cloud console do, abra o Developer Connect.

    Acessar o Developer Connect

    O Developer Connect mostra a página Repositórios Git.

    • Se você vir uma lista de provedores de gerenciamento de código-fonte: Comece a configurar sua primeira conexão selecionando um provedor de gerenciamento de código fonte. Clique em Conectar no card do GitHub.

    • Se você vir uma tabela listando as conexões atuais: defina o provedor de gerenciamento de código-fonte clicando em Criar conexão > GitHub.

      A página Criar conexão é aberta.

  2. Em Região, escolha uma região para os recursos de conexão.

    1. Em Nome, insira um nome para sua nova conexão.

  3. Ative a caixa de seleção Ativar uma conexão compatível com a residência de dados para que essa conexão esteja em conformidade com os requisitos de residência de dados.

    As conexões do GitHub criadas usando o Google Cloud console estão em conformidade com a residência de dados se você ativar essa caixa de seleção ao criar a conexão. Quando você faz isso, o Developer Connect cria um app GitHub

    Quando você cria conexões do GitHub usando a Google Cloud CLI, essas conexões não estão em conformidade com a residência de dados. Todos os outros tipos de conexão estão em conformidade com a residência de dados.

  4. Clique em Mostrar mais para conferir as configurações opcionais.

    1. Opcional: na seção Criptografia, selecione uma chave CMEK para criptografar os secrets do Secret Manager criados pelo Developer Connect.

    2. Opcional: por padrão, o Developer Connect pode atuar como um proxy para chamadas do Git para o GitHub. Para desativar essa opção, desmarque a caixa de seleção Ativar proxy do Developer Connect.

  5. Clique em Continuar.

  6. Clique em Entendi e continuar para concordar em compartilhar seu token OAuth do GitHub com o Developer Connect e armazená-lo no Secret Manager.

  7. Faça login no GitHub, se solicitado.

  8. Clique em Autorizar o Developer Connect para permitir que o app Google Developer Connect acesse sua conta do GitHub.

    Se você não vir essa solicitação, a autorização já foi concedida nessa conta.

  9. Se você selecionou Ativar uma conexão compatível com a residência de dados, será solicitado que você crie um app GitHub.

    1. Forneça um nome para esse app GitHub.

    2. Clique em Criar app GitHub.

    3. Selecione o destino em que você quer instalar o app (sua conta do GitHub ou uma organização).

    4. Selecione os repositórios para instalar o app GitHub ou Todos os repositórios e clique em Instalar.

    5. Selecione os repositórios a serem vinculados para essa conexão e clique em OK.

    6. Clique em Vincular.

O GitHub cria um token, e o Developer Connect o armazena no seu Google Cloud projeto como um secret do Secret Manager. Para mais informações sobre como gerenciar secrets, consulte Visualizar detalhes do secret.

Se você ativou a residência de dados, agora tem um app GitHub, que pode ser gerenciado clicando em Gerenciar instalação na página Detalhes da conexão.

Configurar a conexão

As etapas a seguir são necessárias se você não tiver ativado a caixa de seleção Ativar uma conexão compatível com a residência de dados.

Conceda permissões na sua conta do GitHub e vincule-se a repositórios usando as instruções a seguir. As solicitações que aparecem no navegador da Web dependem de a conta do GitHub já ter o app GitHub do Developer Connect instalado.

Na caixa de diálogo do Developer Connect, siga estas etapas:

Se você vir uma lista de contas do GitHub, instale o app e vincule repositórios seguindo estas etapas:

  1. Escolha a conta do GitHub que você quer usar.

  2. Selecione um ou mais repositórios aos quais você quer conceder acesso.

Se você vir uma solicitação para reutilizar uma instalação de app atual, escolha onde configurar o app seguindo estas etapas:

  1. Clique em Conta do GitHub para conferir as contas que têm o app Google Developer Connect instalado. Se você vir a conta que quer usar, escolha-a clicando em Confirmar.

  2. Se você não vir a conta que quer usar, faça o seguinte:

    1. Escolha Instalar o app GitHub em outra conta do GitHub e clique em Confirmar.

    2. Siga as etapas do GitHub para permitir a instalação do app.

    3. Selecione um ou mais repositórios aos quais você quer conceder acesso.

Quando a caixa de diálogo for fechada, a instalação do app será concluída.

Depois que a conexão for criada, a página Vincular repositórios vai aparecer.

Siga estas etapas para vincular repositórios à sua conexão:

  1. Na lista de repositórios disponíveis, selecione os que você quer usar.

  2. Clique em OK.

  3. Clique em Vincular.

Sua conexão é adicionada à página Conexões e os links do repositório são adicionados à página Repositórios no Google Cloud console. Você pode adicionar mais links às conexões atuais a qualquer momento.

Se você estiver configurando o Gemini Code Assist, continue o processo seguindo as etapas em Configurar e usar a personalização de código do Gemini Code Assist.

gcloud

As tarefas a seguir exigem algumas ações no navegador da Web.

Inicie uma conexão seguindo estas etapas:

  1. Execute o gcloud developer-connect connections create comando para criar uma conexão com o GitHub:

    gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-config-app=APP_TYPE
    --git-proxy-config-enabled

    Substitua:

    • CONNECTION_NAME: o nome da sua conexão.
    • REGION: a região da conexão.
    • APP_TYPE: o tipo de app a ser instalado no GitHub: DEVELOPER-CONNECT para uso com o Gemini Code Assist ou FIREBASE para uso com o Firebase App Hosting.
    • --git-proxy-config-enabled: uma flag opcional que permite que o Developer Connect atue como um proxy para chamadas do Git para o GitHub. Essa capacidade está em pré-lançamento.

    Um nome de conexão é criado.

  2. Conclua a criação da conexão instalando o app GitHub do Developer Connect. Execute o comando a seguir para receber o URI da instalação do app:

    gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

    Substitua:

    • CONNECTION_NAME: o nome da sua conexão.
    • REGION: a região da conexão.

    O Developer Connect retorna um link para concluir as próximas etapas em uma janela do navegador. Copie esse link.

  3. Abra o link em um navegador da Web.

  4. Clique em Entendi e continuar para concordar em compartilhar seu token OAuth do GitHub com o Developer Connect e armazená-lo no Secret Manager.

  5. Faça login no GitHub, se solicitado.

  6. Clique em Autorizar o Developer Connect para permitir que o app Google Developer Connect acesse sua conta do GitHub.

    Se você não vir essa solicitação, a autorização já foi concedida nessa conta.

O GitHub cria um token, e o Developer Connect o armazena no seu Google Cloud projeto como um secret do Secret Manager. Para mais informações sobre como gerenciar secrets, consulte Visualizar detalhes do secret.

Se você ativou uma conexão compatível com a residência de dados, agora tem um app GitHub, que pode ser gerenciado clicando em Gerenciar instalação na página Detalhes da conexão.

Configurar a conexão

Conceda permissões na sua conta do GitHub e vincule-se a repositórios usando as instruções a seguir. As solicitações que aparecem no navegador da Web dependem de a conta do GitHub já ter o app GitHub do Developer Connect instalado.

Na caixa de diálogo do Developer Connect, siga estas etapas:

Se você vir uma lista de contas do GitHub, instale o app e vincule repositórios seguindo estas etapas:

  1. Escolha a conta do GitHub que você quer usar.

  2. Selecione um ou mais repositórios aos quais você quer conceder acesso.

Se você vir uma solicitação para reutilizar uma instalação de app atual, escolha onde configurar o app seguindo estas etapas:

  1. Clique em Conta do GitHub para conferir as contas que têm o app Google Developer Connect instalado. Se você vir a conta que quer usar, escolha-a clicando em Confirmar.

  2. Se você não vir a conta que quer usar, faça o seguinte:

    1. Escolha Instalar o app GitHub em outra conta do GitHub e clique em Confirmar.

    2. Siga as etapas do GitHub para permitir a instalação do app.

    3. Selecione um ou mais repositórios aos quais você quer conceder acesso.

Quando a caixa de diálogo for fechada, a instalação do app será concluída.

Verificar a conexão

Verifique a criação da conexão do GitHub executando o comando a seguir:

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

Substitua:

  • CONNECTION_NAME: o nome da conexão.
  • REGION: a região da conexão.

O Developer Connect retorna um status no campo installationState. Se o valor desse campo for COMPLETE, a instalação do app será concluída. Caso contrário, o Developer Connect retorna um URI para retornar à configuração no navegador.

Depois que a conexão for concluída, escolha quais repositórios vincular seguindo as instruções em Adicionar links de repositório a conexões atuais.

Depois de estabelecer uma conexão com o GitHub, você pode vincular repositórios. Você pode repetir essas etapas mais tarde para vincular outros repositórios conforme necessário.

Para criar links de repositório em uma conexão do GitHub atual, selecione uma das seguintes opções:

Console

  1. Abra a página Repositórios no Google Cloud console.

    Abrir a página Repositórios

  2. Clique em Vincular repositório.

    O painel Vincular repositórios Git é aberto.

  3. Na lista de conexões, escolha uma conexão.

  4. Clique em Continuar.

  5. Na lista de repositórios, selecione os que você quer vincular.

  6. Clique em Criar.

O Developer Connect cria os links do repositório e os mostra em o Google Cloud console.

gcloud

Execute este comando:

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

Substitua:

  • REPO_NAME: o nome do seu repositório
  • REPO_URI: o link para o repositório do GitHub. Por exemplo, https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: o nome da conexão.
  • REGION: a região da conexão.

O Developer Connect cria os links do repositório.

Para listar os repositórios vinculados, execute o developer-connect connections git-repository-links list comando.

Se você estiver configurando o Gemini Code Assist, continue o processo seguindo as etapas em Configurar e usar a personalização de código do Gemini Code Assist.

Compartilhamento de dados pessoais

O conteúdo dos Google Cloud recursos vinculados a essa conexão pode ser transferido para o GitHub. Essa declaração se aplica a todos os recursos atuais e futuros que usam essa conexão. Para interromper o compartilhamento de informações com o GitHub, exclua as conexões do Developer Connect em o Google Cloud console ou na CLI gcloud e revogue o acesso no GitHub.

A seguir