Nesta página, descrevemos como criar conexões com o GitHub e links para repositórios do GitHub. É possível concluir essas tarefas usando o console do Google Cloud ou a Google Cloud CLI.
Estas instruções são destinadas a desenvolvedores de aplicativos, administradores de plataforma 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, adaptadas à sua base de código, ou usar seus repositórios vinculados do GitHub para desenvolver apps da Web com o Firebase App Hosting.
Para saber mais sobre o Developer Connect, consulte Visão geral do Developer Connect.
Antes de começar
-
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 theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Developer Connect, Secret Manager APIs, if any are not already enabled.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
Verifique se você tem acesso a uma conta no GitHub.
Para ajudar a manter o trabalho da sua equipe seguro, recomendamos que você conclua as tarefas deste guia usando uma conta de bot ou uma conta compartilhada pela sua equipe, não uma conta pessoal.
- Verifique se você é proprietário de um repositório do GitHub ou se tem permissões de administrador em um repositório compartilhado.
- Opcional: crie uma chave de criptografia gerenciada pelo cliente (CMEK) para criptografar os secrets de autenticação criados pelo Developer Connect.
- Opcional: para usar as instruções de linha de comando deste guia, siga estas etapas:
- Instale a CLI do Google Cloud. Se
você já instalou a CLI gcloud anteriormente, verifique se tem
a versão mais recente disponível executando
gcloud components update. - Crie uma conta de serviço do Developer Connect
executando o seguinte comando, em que PROJECT_ID é o Google Cloud ID do projeto:
gcloud beta services identity create \ --service=developerconnect.googleapis.com \ --project=PROJECT_ID
- Instale a CLI do Google Cloud. Se
você já instalou a CLI gcloud anteriormente, verifique se tem
a versão mais recente disponível executando
Funções exigidas
Para receber as permissões necessárias para criar conexões e links, peça ao administrador para conceder a você os seguintes papéis do IAM:
-
Se você não for o proprietário do projeto:
Administrador do Developer Connect (
roles/developerconnect.admin) na sua conta de usuário. -
Se você planeja usar uma CMEK para criptografar os secrets criados pelo Developer Connect:
Criptografador/Descriptografador de CryptoKey do Cloud KMS (
roles/cloudkms.cryptoKeyEncrypterDecrypter) na conta de serviço do Secret Manager. -
Se você planeja usar a CLI gcloud para concluir as etapas deste guia:
Papel de administrador do Secret Manager (
roles/secretmanager.admin) na conta de serviço do Developer Connect. -
Se você planeja usar o console do Google Cloud para concluir as etapas deste guia:
Administrador do IAM do projeto (
roles/resourcemanager.projectIamAdmin) na sua conta de usuário.
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 papéis personalizados ou outros papéis predefinidos.
Crie uma conexão
Nesta seção, descrevemos como criar uma conexão entre o Developer Connect e o GitHub. Se você estiver usando o console do Google Cloud , também poderá começar a adicionar links a repositórios ao concluir a configuração da conexão.
Para criar uma nova conexão do GitHub, selecione uma das seguintes opções:
Console
Para iniciar uma conexão, siga estas etapas:
No console do Google Cloud , abra o Developer Connect.
O Developer Connect exibe a página Repositórios Git.
- Se você encontrar 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ê encontrar uma tabela com 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.
Em Região, escolha uma região para os recursos de conexão.
- Em Nome, insira um nome para a nova conexão.
Marque a caixa de seleção Ativar uma conexão compatível com a residência de dados para que essa conexão obedeça aos requisitos de residência de dados.
As conexões do GitHub criadas usando o console do Google Cloud obedecem à 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 do GitHub
Quando você cria conexões do GitHub usando a Google Cloud CLI, elas não obedecem à residência de dados. Todos os outros tipos de conexão obedecem à residência de dados.
Clique em Mostrar mais para ver as configurações opcionais.
Opcional: na seção Criptografia, selecione uma chave CMEK para criptografar os secrets do Secret Manager criados pelo Developer Connect.
Opcional: por padrão, o Developer Connect pode funcionar como um proxy para chamadas do Git para o GitHub. Para desativar essa opção, desmarque a caixa de seleção Ativar o proxy do Developer Connect.
Clique em Continuar.
Clique em Entendo e continuo para concordar em compartilhar seu token OAuth do GitHub com o Developer Connect e armazená-lo no Secret Manager.
Faça login no GitHub se for solicitado.
Clique em Autorizar o Developer Connect para permitir que o app Google Developer Connect acesse sua conta do GitHub.
Se essa solicitação não aparecer, significa que a autorização já foi concedida nessa conta.
Se você selecionou Ativar uma conexão compatível com a residência de dados, será solicitado que você crie um app do GitHub.
Dê um nome para este app do GitHub.
Clique em Criar app do GitHub.
Selecione o destino em que você quer instalar o app (sua conta do GitHub ou uma organização).
Selecione os repositórios em que o app do GitHub será instalado ou Todos os repositórios e clique em Instalar.
Selecione os repositórios que serão vinculados a essa conexão e clique em Ok.
Clique em Vincular.
O GitHub cria um token, e o Developer Connect o armazena no seu projeto doGoogle Cloud como um secret do Secret Manager. Para mais informações sobre como gerenciar secrets, consulte Ver detalhes do secret.
Se você ativou a residência de dados, agora tem um app do 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 serão necessárias se você não tiver marcado a caixa de seleção Ativar conexão em conformidade com a residência de dados.
Conceda permissões na sua conta do GitHub e vincule-a aos 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 Developer Connect GitHub instalado.
Na caixa de diálogo do Developer Connect, siga estas etapas:
Se você encontrar uma lista de contas do GitHub, instale o app e vincule repositórios seguindo estas etapas:
Escolha a conta do GitHub que você quer usar.
Selecione um ou mais repositórios aos quais você quer conceder acesso.
Se aparecer uma solicitação para reutilizar uma instalação de app, escolha onde configurar o app seguindo estas etapas:
Clique em Conta do GitHub para ver as contas que têm o app Google Developer Connect instalado. Se a conta que você quer usar aparecer, clique em Confirmar.
Se você não encontrar a conta que quer usar, faça o seguinte:
Escolha Instalar o app GitHub em outra conta do GitHub e clique em Confirmar.
Siga as etapas do GitHub para permitir a instalação do app.
Selecione um ou mais repositórios aos quais você quer conceder acesso.
Quando a caixa de diálogo fechar, a instalação do app estará 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:
Na lista de repositórios disponíveis, selecione os que você quer usar.
Clique em OK.
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 console do Google Cloud . É possível adicionar mais links às conexões atuais a qualquer momento.
Se você estiver configurando o Gemini Code Assist, siga 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.
Para iniciar uma conexão, siga estas etapas:
Execute o comando
gcloud developer-connect connections createpara criar uma conexão com o GitHub:gcloud developer-connect connections create CONNECTION_NAME \ --location=REGION \ --github-config-app=APP_TYPE \ --git-proxy-config-enabledSubstitua:
- CONNECTION_NAME: o nome da conexão.
- REGION: a região da conexão.
APP_TYPE: o tipo de app a ser instalado no GitHub. Opções:
FIREBASEpara uso com o Firebase App HostingDATAFORMpara uso com o DataformGEMINI_CODE_ASSISTpara uso com o Gemini Code AssistDEVELOPER_CONNECTpara uso com todo o resto--git-proxy-config-enabled: uma flag opcional que permite que o Developer Connect atue como um proxy para chamadas do Git para o GitHub.
Um nome de conexão é criado.
Para concluir a criação da conexão, instale o app Developer Connect do GitHub. Execute o seguinte comando para receber o URI de instalação do app:
gcloud developer-connect connections describe CONNECTION_NAME \ --location=REGIONSubstitua:
- CONNECTION_NAME: o nome da 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.
Abra o link em um navegador da Web.
Clique em Entendo e continuo para concordar em compartilhar seu token OAuth do GitHub com o Developer Connect e armazená-lo no Secret Manager.
Faça login no GitHub se for solicitado.
Clique em Autorizar o Developer Connect para permitir que o app Google Developer Connect acesse sua conta do GitHub.
Se essa solicitação não aparecer, significa que a autorização já foi concedida nessa conta.
O GitHub cria um token, e o Developer Connect o armazena no seu projeto doGoogle Cloud como um secret do Secret Manager. Para mais informações sobre como gerenciar secrets, consulte Ver detalhes do secret.
Se você ativou uma conexão compatível com a residência de dados, agora tem um app do 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-a aos 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 Developer Connect GitHub instalado.
Na caixa de diálogo do Developer Connect, siga estas etapas:
Se você encontrar uma lista de contas do GitHub, instale o app e vincule repositórios seguindo estas etapas:
Escolha a conta do GitHub que você quer usar.
Selecione um ou mais repositórios aos quais você quer conceder acesso.
Se aparecer uma solicitação para reutilizar uma instalação de app, escolha onde configurar o app seguindo estas etapas:
Clique em Conta do GitHub para ver as contas que têm o app Google Developer Connect instalado. Se a conta que você quer usar aparecer, clique em Confirmar.
Se você não encontrar a conta que quer usar, faça o seguinte:
Escolha Instalar o app GitHub em outra conta do GitHub e clique em Confirmar.
Siga as etapas do GitHub para permitir a instalação do app.
Selecione um ou mais repositórios aos quais você quer conceder acesso.
Quando a caixa de diálogo fechar, a instalação do app estará concluída.
Verifique a conexão
Verifique a criação da conexão do GitHub executando o seguinte comando:
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 estará concluída.
Caso contrário, o Developer Connect retorna um URI para que você volte à
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.
Adicionar links de repositório a conexões atuais
Depois de estabelecer uma conexão com o GitHub, é possível vincular a repositórios. Repita essas etapas mais tarde para vincular outros repositórios, conforme necessário.
Para criar links de repositório em uma conexão do GitHub, selecione uma das seguintes opções:
Console
Abra a página Repositórios no console do Google Cloud .
Clique em Vincular repositório.
O painel Vincular repositórios Git é aberto.
Na lista de conexões, escolha uma.
Clique em Continuar.
Na lista de repositórios, selecione os que você quer vincular.
Clique em Criar.
O Developer Connect cria os links do repositório e os exibe no console do Google Cloud .
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 repositórios vinculados, execute o
comando developer-connect connections git-repository-links list.
Se você estiver configurando o Gemini Code Assist, siga as etapas em Configurar e usar a personalização de código do Gemini Code Assist.
Compartilhamento de dados pessoais
O conteúdo dos recursos do Google Cloud vinculados a essa conexão pode ser transferido para o GitHub. Essa declaração se aplica a todos os recursos atuais e futuros que usarem essa conexão. Para parar de compartilhar informações com o GitHub, exclua as conexões do Developer Connect no o console do Google Cloud ou na CLI gcloud e revogue o acesso no GitHub.