Connettiti a GitHub

Questa pagina descrive come creare connessioni a GitHub e link ai repository GitHub. Puoi completare queste attività utilizzando la Google Cloud console, o Google Cloud CLI.

Queste istruzioni sono destinate a sviluppatori di applicazioni, amministratori di piattaforme e responsabili della sicurezza che vogliono utilizzare i repository di codice sorgente GitHub con Google.

Ad esempio, puoi ricevere suggerimenti di codifica da Gemini Code Assist, personalizzati per la tua codebase, oppure puoi utilizzare i repository GitHub collegati per sviluppare app web con Firebase App Hosting.

Per saperne di più su Developer Connect, consulta la panoramica di Developer Connect.

Prima di iniziare

Accedi al tuo Account Google.

Se non ne hai già uno, registrati per creare un nuovo account.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

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

L'abilitazione di Developer Connect abilita anche l' API Secret Manager.

1. Assicurati di avere accesso a un account su GitHub.

   Per proteggere il lavoro del tuo team, ti consigliamo di completare le attività descritte in questa guida utilizzando un account bot o un account condiviso dal tuo team, non un account personale.

2. Assicurati di essere il proprietario di un repository GitHub o di avere autorizzazioni a livello di amministratore su un repository condiviso.
3. (Facoltativo) Crea una chiave di crittografia gestita dal cliente (CMEK) per criptare i secret di autenticazione creati da Developer Connect.
4. (Facoltativo) Per utilizzare le istruzioni della riga di comando in questa guida, completa i seguenti passaggi:
   1. Installa la Google Cloud CLI. Se hai già installato gcloud CLI, assicurati di avere l'ultima versione disponibile eseguendo gcloud components update.
   2. Crea un service account Developer Connect eseguendo il seguente comando, dove PROJECT_ID è l'Google Cloud ID progetto:

              gcloud beta services identity create \
                  --service=developerconnect.googleapis.com \
                  --project=PROJECT_ID
              

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per creare connessioni e link, chiedi all'amministratore di concederti i seguenti ruoli IAM:

• Se non sei il proprietario del progetto: Amministratore di Developer Connect (roles/developerconnect.admin) sul tuo account utente.
• Se prevedi di utilizzare una CMEK per criptare i secret creati da Developer Connect: Autore crittografia/decrittografia CryptoKey Cloud KMS (roles/cloudkms.cryptoKeyEncrypterDecrypter) sul service account Secret Manager.
• Se prevedi di utilizzare gcloud CLI per completare i passaggi descritti in questa guida: ruolo Amministratore di Secret Manager (roles/secretmanager.admin) sul service account Developer Connect.
• Se prevedi di utilizzare la Google Cloud console per completare i passaggi descritti in questa guida: Amministratore IAM progetto (roles/resourcemanager.projectIamAdmin) sul tuo account utente.

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Nota: quando hai il ruolo Amministratore IAM progetto (roles/resourcemanager.projectIamAdmin) la Google Cloud console può concedere automaticamente le autorizzazioni necessarie per tuo conto. Se l'amministratore non ti consente di avere il ruolo Amministratore IAM progetto, chiedigli di concedere il ruolo Amministratore di Secret Manager (roles/secretmanager.admin) sul service account Developer Connect (service-{projectNumber}@gcp-sa-devconnect.iam.gserviceaccount.com).

Crea una connessione

Questa sezione descrive come creare una connessione tra Developer Connect e GitHub. Se utilizzi la Google Cloud console, puoi anche iniziare ad aggiungere link ai repository al termine della configurazione della connessione.

Per creare una nuova connessione GitHub, seleziona una delle seguenti opzioni:

Console

Avvia una connessione completando i seguenti passaggi:

1. Nella Google Cloud console, apri Developer Connect.

   Vai a Developer Connect

   Developer Connect mostra la pagina Repository Git.

   • Se vedi un elenco di provider di gestione del codice sorgente: inizia a configurare la prima connessione selezionando un provider di gestione del codice sorgente. Fai clic su Connetti sulla scheda GitHub.

   • Se vedi una tabella che elenca le connessioni esistenti: imposta il provider di gestione del codice sorgente facendo clic su Crea connessione > GitHub.

     Si apre la pagina Crea connessione.

2. In Regione, scegli una regione per le risorse di connessione.

   1. In Nome, inserisci un nome per la nuova connessione.

3. Attiva la casella di controllo Abilita una connessione conforme alla residenza dei dati per rendere questa connessione conforme ai requisiti di residenza dei dati.

   Le connessioni GitHub create utilizzando la Google Cloud console sono conformi alla residenza dei dati se attivi questa casella di controllo quando crei la connessione. In questo caso, Developer Connect crea un'app GitHub

   Quando crei connessioni GitHub utilizzando Google Cloud CLI, queste connessioni non sono conformi alla residenza dei dati. Tutti gli altri tipi di connessione sono conformi alla residenza dei dati.

4. Fai clic su Mostra altro per visualizzare le impostazioni di configurazione facoltative.

   1. (Facoltativo) Nella sezione Crittografia, seleziona una chiave CMEK per criptare i secret di Secret Manager creati da Developer Connect.

   2. (Facoltativo) Per impostazione predefinita, Developer Connect può fungere da proxy per le chiamate Git a GitHub. Per disattivare questa opzione, deseleziona la casella di controllo Abilita proxy Developer Connect.

5. Fai clic su Continua.

6. Fai clic su Comprendo e continuo per accettare di condividere il tuo token OAuth GitHub con Developer Connect e di archiviarlo in Secret Manager.

7. Accedi a GitHub, se ti viene richiesto.

8. Fai clic su Autorizza Developer Connect per consentire all'app Google Developer Connect di accedere al tuo account GitHub.

   Se non vedi questa richiesta, l'autorizzazione è già stata concessa su questo account.

9. Se hai selezionato Abilita una connessione conforme alla residenza dei dati, ti viene chiesto di creare un'app GitHub.

   1. Fornisci un nome per questa app GitHub.

   2. Fai clic su Crea app GitHub.

   3. Seleziona la destinazione in cui vuoi installare l'app (il tuo account GitHub o un'organizzazione).

   4. Seleziona i repository per cui installare l'app GitHub o Tutti i repository e fai clic su Installa.

   5. Seleziona i repository da collegare per questa connessione e fai clic su Ok.

   6. Fai clic su Collega.

GitHub crea un token e Developer Connect lo archivia nel tuo Google Cloud progetto come secret di Secret Manager. Per saperne di più sulla gestione dei secret, consulta Visualizzare i dettagli dei secret.

Se hai abilitato la residenza dei dati, ora hai un'app GitHub, che puoi gestire facendo clic su Gestisci installazione nella pagina Dettagli connessione.

Configura la connessione

I seguenti passaggi sono obbligatori se non hai attivato la casella di controllo Abilita connessione conforme alla residenza dei dati.

Concedi le autorizzazioni sul tuo account GitHub e collega i repository utilizzando le seguenti istruzioni. Le richieste visualizzate nel browser web dipendono dal fatto che l'app GitHub di Developer Connect sia già installata nell'account GitHub.

Nella finestra di dialogo Developer Connect, completa i seguenti passaggi:

Se vedi un elenco di account GitHub, installa l'app e collega i repository completando questi passaggi:

1. Scegli l'account GitHub che vuoi utilizzare.

2. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Se vedi una richiesta di riutilizzo di un'installazione dell'app esistente, scegli dove configurare l'app completando questi passaggi:

1. Fai clic su Account GitHub per visualizzare gli account in cui è installata l'app Google Developer Connect. Se vedi l'account che vuoi utilizzare, scegli Conferma.

2. Se non vedi l'account che vuoi utilizzare:

   1. Scegli Installa l'app GitHub su un altro account GitHub e fai clic su Conferma.

   2. Segui i passaggi di GitHub per consentire l'installazione dell'app.

   3. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Al termine della finestra di dialogo, l'installazione dell'app è completa.

Una volta creata la connessione, viene visualizzata la pagina Collega repository.

Completa i seguenti passaggi per collegare i repository alla connessione:

1. Nell'elenco dei repository disponibili, seleziona i repository che vuoi utilizzare.

2. Fai clic su OK.

3. Fai clic su Collega.

La connessione viene aggiunta alla pagina Connessioni e i link ai repository vengono aggiunti alla pagina Repository nella Google Cloud console. Puoi aggiungere altri link alle connessioni esistenti in qualsiasi momento.

Se stai configurando Gemini Code Assist, continua la procedura seguendo i passaggi descritti in Configurare e utilizzare la personalizzazione del codice di Gemini Code Assist.

gcloud

Le seguenti attività richiedono alcune azioni nel browser web.

Avvia una connessione completando i seguenti passaggi:

1. Esegui il gcloud developer-connect connections create comando per creare una connessione a GitHub:

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

   Sostituisci quanto segue:

   • CONNECTION_NAME: il nome della connessione.
   • REGION: la regione della connessione.
   • APP_TYPE: il tipo di app da installare in GitHub: DEVELOPER-CONNECT per l'utilizzo con Gemini Code Assist o FIREBASE per l'utilizzo con Firebase App Hosting.
   • --git-proxy-config-enabled: un flag facoltativo che consente a Developer Connect di fungere da proxy per le chiamate Git a GitHub. Questa funzionalità è in anteprima.

   Viene creato un nome di connessione.

2. Completa la creazione della connessione installando l'app GitHub di Developer Connect. Esegui il seguente comando per ottenere l'URI per l'installazione dell'app:

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

   Sostituisci quanto segue:

   • CONNECTION_NAME: il nome della connessione.
   • REGION: la regione della connessione.

   Developer Connect restituisce un link per completare i passaggi successivi in una finestra del browser. Copia questo link.

3. Apri il link in un browser web.

4. Fai clic su Comprendo e continuo per accettare di condividere il tuo token OAuth GitHub con Developer Connect e di archiviarlo in Secret Manager.

5. Accedi a GitHub, se ti viene richiesto.

6. Fai clic su Autorizza Developer Connect per consentire all'app Google Developer Connect di accedere al tuo account GitHub.

   Se non vedi questa richiesta, l'autorizzazione è già stata concessa su questo account.

GitHub crea un token e Developer Connect lo archivia nel tuo Google Cloud progetto come secret di Secret Manager. Per saperne di più sulla gestione dei secret, consulta Visualizzare i dettagli dei secret.

Se hai abilitato una connessione conforme alla residenza dei dati, ora hai un'app GitHub, che puoi gestire facendo clic su Gestisci installazione nella pagina Dettagli connessione.

Configura la connessione

Concedi le autorizzazioni sul tuo account GitHub e collega i repository utilizzando le seguenti istruzioni. Le richieste visualizzate nel browser web dipendono dal fatto che l'app GitHub di Developer Connect sia già installata nell'account GitHub.

Nella finestra di dialogo Developer Connect, completa i seguenti passaggi:

Se vedi un elenco di account GitHub, installa l'app e collega i repository completando questi passaggi:

1. Scegli l'account GitHub che vuoi utilizzare.

2. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Se vedi una richiesta di riutilizzo di un'installazione dell'app esistente, scegli dove configurare l'app completando questi passaggi:

1. Fai clic su Account GitHub per visualizzare gli account in cui è installata l'app Google Developer Connect. Se vedi l'account che vuoi utilizzare, scegli Conferma.

2. Se non vedi l'account che vuoi utilizzare:

   1. Scegli Installa l'app GitHub su un altro account GitHub e fai clic su Conferma.

   2. Segui i passaggi di GitHub per consentire l'installazione dell'app.

   3. Seleziona uno o più repository a cui vuoi concedere l'accesso.

Al termine della finestra di dialogo, l'installazione dell'app è completa.

Verificare la connessione

Verifica la creazione della connessione GitHub eseguendo il seguente comando:

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

Sostituisci quanto segue:

• CONNECTION_NAME: il nome della connessione.
• REGION: la regione della connessione.

Developer Connect restituisce uno stato nel campo installationState. Se il valore di questo campo è COMPLETE, l'installazione dell'app è terminata. In caso contrario, Developer Connect restituisce un URI per riportarti alla configurazione nel browser.

Una volta completata la connessione, scegli i repository da collegare seguendo le istruzioni riportate in Aggiungere link ai repository alle connessioni esistenti.

Aggiungi link ai repository alle connessioni esistenti

Dopo aver stabilito una connessione a GitHub, puoi collegare i repository. Puoi ripetere questi passaggi in un secondo momento per collegare altri repository, se necessario.

Per creare link ai repository su una connessione GitHub esistente, seleziona una delle seguenti opzioni:

Console

1. Apri la pagina Repository nella Google Cloud console.

   Apri la pagina Repository

2. Fai clic su Collega repository.

   Si apre il riquadro Collega repository Git.

3. Nell'elenco delle connessioni, scegli una connessione.

4. Fai clic su Continua.

5. Nell'elenco dei repository, seleziona i repository a cui vuoi collegarti.

6. Fai clic su Crea.

Developer Connect crea i link ai repository e li visualizza in the Google Cloud console.

gcloud

Esegui questo comando:

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

Sostituisci quanto segue:

• REPO_NAME: il nome del repository.
• REPO_URI: il link al repository GitHub. Ad esempio, https://github.com/cloud-build/test-repo.git.
• CONNECTION_NAME: il nome della connessione.
• REGION: la regione della connessione.

Developer Connect crea i link ai repository.

Per elencare i repository collegati, esegui il developer-connect connections git-repository-links list comando.

Se stai configurando Gemini Code Assist, continua la procedura seguendo i passaggi descritti in Configurare e utilizzare la personalizzazione del codice di Gemini Code Assist.

Condivisione dei dati

I contenuti dellerisorse collegate a questa connessione potrebbero essere trasferiti a GitHub. Google Cloud Questa affermazione si applica a tutte le risorse esistenti e future che utilizzano questa connessione. Per interrompere la condivisione delle informazioni con GitHub, elimina le connessioni Developer Connect nella console o in gcloud CLI e revoca l'accesso in GitHub. Google Cloud

Passaggi successivi

• Completa la configurazione della personalizzazione del codice di Gemini Code Assist.
• Scopri come Gemini Code Assist ti aiuta ad accelerare lo sviluppo di software.
• Esplora altre integrazioni disponibili tramite Developer Connect.