Verbindung zu GitHub herstellen

Auf dieser Seite wird beschrieben, wie Sie Verbindungen zu GitHub herstellen und Links zu GitHub-Repositories erstellen. Sie können diese Aufgaben mit der Google Cloud Console oder der Google Cloud CLI ausführen.

Diese Anleitung richtet sich an Anwendungsentwickler, Plattformadministratoren und Sicherheitsmanager, die GitHub-Quellcode-Repositories mit Google verwenden möchten.

Sie können beispielsweise von Gemini Code Assist auf Ihre Codebasis zugeschnittene Vorschläge für Code erhalten oder Ihre verknüpften GitHub-Repositories verwenden, um Web-Apps mit Firebase App Hosting zu entwickeln.

Weitere Informationen zu Developer Connect finden Sie in der Übersicht über Developer Connect.

Hinweis

  1. Melden Sie sich in Ihrem Google-Konto an.

    Wenn Sie noch kein Konto haben, melden Sie sich hier für ein neues Konto an.

  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.

    Wenn Sie Developer Connect aktivieren, wird auch die Secret Manager API aktiviert.

  8. Sie benötigen Zugriff auf ein Konto auf GitHub.

    Damit die Arbeit Ihres Teams geschützt ist, empfehlen wir, die Aufgaben in dieser Anleitung mit einem Bot-Konto oder einem von Ihrem Team gemeinsam genutzten Konto und nicht mit einem persönlichen Konto auszuführen.

  9. Sie müssen Inhaber eines GitHub-Repositorys sein oder Berechtigungen auf Administratorebene für ein freigegebenes Repository haben.
  10. Optional: Erstellen Sie einen vom Kunden verwalteten Verschlüsselungsschlüssel (Customer-Managed Encryption Key, CMEK) zum Verschlüsseln der Authentifizierungs-Secrets, die von Developer Connect erstellt werden.
  11. Optional: Wenn Sie die Befehlszeilenanleitung in diesem Leitfaden verwenden möchten, führen Sie die folgenden Schritte aus:
    1. Installieren Sie die Google Cloud CLI. Wenn Sie die gcloud CLI bereits installiert haben, prüfen Sie, ob Sie die neueste verfügbare Version haben. Führen Sie dazu den Befehl gcloud components update aus.
    2. Erstellen Sie ein Developer Connect-Dienstkonto, indem Sie den folgenden Befehl ausführen. Dabei ist PROJECT_ID Ihre Google Cloud Projekt-ID: 
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Erstellen von Verbindungen und Links benötigen:

  • Wenn Sie nicht der Projektinhaber sind: Developer Connect-Administrator (roles/developerconnect.admin) für Ihr Nutzerkonto.
  • Wenn Sie einen CMEK zum Verschlüsseln der von Developer Connect erstellten Secrets verwenden möchten: Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter) für das Secret Manager-Dienstkonto.
  • Wenn Sie die gcloud CLI verwenden möchten, um die Schritte in dieser Anleitung auszuführen: Rolle „Secret Manager-Administrator“ (roles/secretmanager.admin) für das Developer Connect-Dienstkonto.
  • Wenn Sie die Google Cloud Console verwenden möchten, um die Schritte in dieser Anleitung auszuführen, benötigen Sie die IAM-Rolle Project IAM Admin (roles/resourcemanager.projectIamAdmin) für Ihr Nutzerkonto.

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Verbindung herstellen

In diesem Abschnitt wird beschrieben, wie Sie eine Verbindung zwischen Developer Connect und GitHub herstellen. Wenn Sie die Google Cloud -Konsole verwenden, können Sie auch Links zu Repositories hinzufügen, sobald Sie die Einrichtung Ihrer Verbindung abgeschlossen haben.

Wählen Sie eine der folgenden Optionen aus, um eine neue GitHub-Verbindung zu erstellen:

Console

So stellen Sie eine Verbindung her:

  1. Öffnen Sie in der Google Cloud Console Developer Connect.

    Zu Developer Connect

    In Developer Connect wird die Seite Git-Repositories angezeigt.

    • Wenn Sie eine Liste von Anbietern für die Quellcodeverwaltung sehen:Konfigurieren Sie Ihre erste Verbindung, indem Sie einen Anbieter für die Quellcodeverwaltung auswählen. Klicken Sie auf der GitHub-Karte auf Verbinden.

    • Wenn eine Tabelle mit vorhandenen Verbindungen angezeigt wird: Legen Sie den Anbieter für die Quellcodeverwaltung fest, indem Sie auf Verbindung erstellen > GitHub klicken.

      Die Seite Verbindung erstellen wird geöffnet.

  2. Wählen Sie unter Region eine Region für Ihre Verbindungsressourcen aus.

    1. Geben Sie unter Name einen Namen für die neue Verbindung ein.

  3. Aktivieren Sie das Kästchen Datenstandortkonforme Verbindung aktivieren, damit diese Verbindung den Anforderungen an den Datenstandort entspricht.

    GitHub-Verbindungen, die mit der Google Cloud Console erstellt wurden, entsprechen den Anforderungen an den Datenstandort, wenn Sie dieses Kästchen beim Erstellen der Verbindung aktivieren. Wenn Sie dies tun, erstellt Developer Connect eine GitHub-App.

    Wenn Sie GitHub-Verbindungen mit der Google Cloud CLI erstellen, sind diese Verbindungen nicht datenstandortkonform. Alle anderen Verbindungstypen entsprechen den Anforderungen an den Datenstandort.

  4. Klicken Sie auf Mehr anzeigen, um optionale Konfigurationseinstellungen aufzurufen.

    1. Optional: Wählen Sie im Abschnitt Verschlüsselung einen CMEK-Schlüssel aus, um Secret Manager-Secrets zu verschlüsseln, die von Developer Connect erstellt werden.

    2. Optional: Standardmäßig kann Developer Connect als Proxy für Git-Aufrufe an GitHub fungieren. Wenn Sie diese Option deaktivieren möchten, entfernen Sie das Häkchen aus dem Kästchen Developer Connect-Proxy aktivieren.

  5. Klicken Sie auf Weiter.

  6. Klicken Sie auf Ich stimme zu und fahre fort, um zuzustimmen, dass Ihr GitHub-OAuth-Token für Developer Connect freigegeben und in Secret Manager gespeichert wird.

  7. Melden Sie sich bei GitHub an, wenn Sie dazu aufgefordert werden.

  8. Klicken Sie auf Developer Connect autorisieren, um der Google Developer Connect-App den Zugriff auf Ihr GitHub-Konto zu erlauben.

    Wenn diese Aufforderung nicht angezeigt wird, wurde die Autorisierung für dieses Konto bereits erteilt.

  9. Wenn Sie Datenstandortkonforme Verbindung aktivieren ausgewählt haben, werden Sie aufgefordert, eine GitHub-App zu erstellen.

    1. Geben Sie einen Namen für diese GitHub-App an.

    2. Klicken Sie auf GitHub-App erstellen.

    3. Wählen Sie das Ziel aus, auf dem Sie die App installieren möchten (Ihr GitHub-Konto oder eine Organisation).

    4. Wählen Sie die Repositories aus, für die die GitHub-App installiert werden soll, oder Alle Repositories und klicken Sie auf Installieren.

    5. Wählen Sie die Repositories aus, die für diese Verbindung verknüpft werden sollen, und klicken Sie auf Ok.

    6. Klicken Sie auf Verknüpfen.

GitHub erstellt ein Token und Developer Connect speichert es in IhremGoogle Cloud -Projekt als Secret Manager-Secret. Weitere Informationen zum Verwalten von Secrets finden Sie unter Secret-Details ansehen.

Wenn Sie den Datenstandort aktiviert haben, haben Sie jetzt eine GitHub-App, die Sie verwalten können, indem Sie auf der Seite Verbindungsdetails auf Installation verwalten klicken.

Verbindung konfigurieren

Die folgenden Schritte sind erforderlich, wenn Sie das Kästchen Enable data residency-compliant connection (Verbindung gemäß Datenstandort aktivieren) nicht aktiviert haben.

Gewähren Sie Berechtigungen für Ihr GitHub-Konto und verknüpfen Sie es mit Repositories. Folgen Sie dazu der Anleitung unten. Die Aufforderungen, die in Ihrem Webbrowser angezeigt werden, hängen davon ab, ob die Developer Connect-GitHub-App bereits im GitHub-Konto installiert ist.

Führen Sie im Dialogfeld „Developer Connect“ die folgenden Schritte aus:

Wenn Sie eine Liste von GitHub-Konten sehen, installieren Sie die App und verknüpfen Sie die Repositorys so:

  1. Wählen Sie das GitHub-Konto aus, das Sie verwenden möchten.

  2. Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.

Wenn Sie aufgefordert werden, eine vorhandene App-Installation wiederzuverwenden, wählen Sie aus, wo die App konfiguriert werden soll, indem Sie diese Schritte ausführen:

  1. Klicken Sie auf GitHub-Konto, um Konten mit installierter Google Developer Connect App aufzurufen. Wenn das gewünschte Konto angezeigt wird, wählen Sie es aus, indem Sie auf Bestätigen klicken.

  2. Wenn Sie das gewünschte Konto nicht sehen, gehen Sie so vor:

    1. Wählen Sie GitHub-Anwendung in anderem GitHub-Konto installieren aus und klicken Sie auf Bestätigen.

    2. Folgen Sie der GitHub-Anleitung, um die Installation der App zuzulassen.

    3. Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.

Wenn das Dialogfeld geschlossen wird, ist die App-Installation abgeschlossen.

Nachdem die Verbindung erstellt wurde, wird die Seite Repositories verknüpfen angezeigt.

Führen Sie die folgenden Schritte aus, um Repositories mit Ihrer Verbindung zu verknüpfen:

  1. Wählen Sie in der Liste der verfügbaren Repositories die Repositories aus, die Sie verwenden möchten.

  2. Klicken Sie auf OK.

  3. Klicken Sie auf Verknüpfen.

Ihre Verbindung wird der Seite Verbindungen hinzugefügt und Ihre Repository-Links werden der Seite Repositories in der Google Cloud Console hinzugefügt. Sie können bestehenden Verbindungen jederzeit weitere Links hinzufügen.

Wenn Sie Gemini Code Assist einrichten, fahren Sie mit den Schritten unter Codeanpassung für Gemini Code Assist konfigurieren und verwenden fort.

gcloud

Für die folgenden Aufgaben sind einige Aktionen in Ihrem Webbrowser erforderlich.

So stellen Sie eine Verbindung her:

  1. Führen Sie den Befehl gcloud developer-connect connections create aus, um eine Verbindung zu GitHub herzustellen:

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

    Ersetzen Sie Folgendes:

    • CONNECTION_NAME: der Name der Verbindung.
    • REGION: die Region für Ihre Verbindung.

    • APP_TYPE: Der Typ der App, die in GitHub installiert werden soll. Eines der folgenden Betriebssysteme:

      FIREBASE für die Verwendung mit Firebase App Hosting

      DATAFORM zur Verwendung mit Dataform

      GEMINI_CODE_ASSIST für die Verwendung mit Gemini Code Assist

      DEVELOPER_CONNECT für die Verwendung mit allem anderen

    • --git-proxy-config-enabled: Ein optionales Flag, mit dem Developer Connect als Proxy für Git-Aufrufe an GitHub fungieren kann. Diese Funktion befindet sich in der Vorschau.

    Es wird ein Verbindungsname erstellt.

  2. Schließen Sie die Erstellung der Verbindung ab, indem Sie die Developer Connect-GitHub-App installieren. Führen Sie den folgenden Befehl aus, um den URI für die App-Installation abzurufen:

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

    Ersetzen Sie Folgendes:

    • CONNECTION_NAME: der Name der Verbindung.
    • REGION: die Region für Ihre Verbindung.

    Developer Connect gibt einen Link zurück, über den Sie die nächsten Schritte in einem Browserfenster ausführen können. Kopieren Sie den Link.

  3. Öffnen Sie den Link in einem Webbrowser.

  4. Klicken Sie auf Ich stimme zu und fahre fort, um zuzustimmen, dass Ihr GitHub-OAuth-Token für Developer Connect freigegeben und in Secret Manager gespeichert wird.

  5. Melden Sie sich bei GitHub an, wenn Sie dazu aufgefordert werden.

  6. Klicken Sie auf Developer Connect autorisieren, um der Google Developer Connect-App den Zugriff auf Ihr GitHub-Konto zu erlauben.

    Wenn diese Aufforderung nicht angezeigt wird, wurde die Autorisierung für dieses Konto bereits erteilt.

GitHub erstellt ein Token und Developer Connect speichert es in IhremGoogle Cloud -Projekt als Secret Manager-Secret. Weitere Informationen zum Verwalten von Secrets finden Sie unter Secret-Details ansehen.

Wenn Sie eine datenstandortkonforme Verbindung aktiviert haben, haben Sie jetzt eine GitHub-App, die Sie verwalten können, indem Sie auf der Seite Verbindungsdetails auf Installation verwalten klicken.

Verbindung konfigurieren

Gewähren Sie Berechtigungen für Ihr GitHub-Konto und verknüpfen Sie es mit Repositories. Folgen Sie dazu der Anleitung unten. Die Aufforderungen, die in Ihrem Webbrowser angezeigt werden, hängen davon ab, ob die Developer Connect-GitHub-App bereits im GitHub-Konto installiert ist.

Führen Sie im Dialogfeld „Developer Connect“ die folgenden Schritte aus:

Wenn Sie eine Liste von GitHub-Konten sehen, installieren Sie die App und verknüpfen Sie die Repositorys so:

  1. Wählen Sie das GitHub-Konto aus, das Sie verwenden möchten.

  2. Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.

Wenn Sie aufgefordert werden, eine vorhandene App-Installation wiederzuverwenden, wählen Sie aus, wo die App konfiguriert werden soll, indem Sie diese Schritte ausführen:

  1. Klicken Sie auf GitHub-Konto, um Konten mit installierter Google Developer Connect App aufzurufen. Wenn das gewünschte Konto angezeigt wird, wählen Sie es aus, indem Sie auf Bestätigen klicken.

  2. Wenn Sie das gewünschte Konto nicht sehen, gehen Sie so vor:

    1. Wählen Sie GitHub-Anwendung in anderem GitHub-Konto installieren aus und klicken Sie auf Bestätigen.

    2. Folgen Sie der GitHub-Anleitung, um die Installation der App zuzulassen.

    3. Wählen Sie ein oder mehrere Repositorys aus, auf die Sie Zugriff gewähren möchten.

Wenn das Dialogfeld geschlossen wird, ist die App-Installation abgeschlossen.

Verbindung prüfen

Prüfen Sie die Erstellung der GitHub-Verbindung mit dem folgenden Befehl:

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

Ersetzen Sie Folgendes:

  • CONNECTION_NAME: der Name Ihrer Verbindung.
  • REGION: die Region für Ihre Verbindung.

Developer Connect gibt einen Status im Feld installationState zurück. Wenn der Wert dieses Felds COMPLETE ist, ist die Installation Ihrer App abgeschlossen. Andernfalls gibt Developer Connect einen URI zurück, über den Sie zur Konfiguration im Browser zurückkehren können.

Wenn die Verbindung hergestellt ist, wählen Sie die Repositories aus, die Sie verknüpfen möchten. Folgen Sie dazu der Anleitung unter Repository-Links zu bestehenden Verbindungen hinzufügen.

Nachdem Sie eine Verbindung zu GitHub hergestellt haben, können Sie Repositories verknüpfen. Sie können diese Schritte später wiederholen, um bei Bedarf weitere Repositories zu verknüpfen.

Wenn Sie Repository-Links für eine vorhandene GitHub-Verbindung erstellen möchten, wählen Sie eine der folgenden Optionen aus:

Console

  1. Öffnen Sie in der Google Cloud Console die Seite Repositories.

    Öffnen Sie die Seite Repositories.

  2. Klicken Sie auf Repository verknüpfen.

    Der Bereich Git-Repositories verknüpfen wird geöffnet.

  3. Wählen Sie in der Liste der Verbindungen eine Verbindung aus.

  4. Klicken Sie auf Weiter.

  5. Wählen Sie in der Repository-Liste die Repositories aus, mit denen Sie eine Verknüpfung herstellen möchten.

  6. Klicken Sie auf Erstellen.

Developer Connect erstellt die Repository-Links und zeigt sie in der Google Cloud Konsole an.

gcloud

Führen Sie dazu diesen Befehl aus:

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

Ersetzen Sie Folgendes:

  • REPO_NAME: der Name Ihres Repositorys.
  • REPO_URI: der Link zu Ihrem GitHub-Repository. Beispiel: https://github.com/cloud-build/test-repo.git.
  • CONNECTION_NAME: der Name Ihrer Verbindung.
  • REGION: die Region für Ihre Verbindung.

Die Repository-Links werden von Developer Connect erstellt.

Führen Sie den Befehl developer-connect connections git-repository-links list aus, um verknüpfte Repositories aufzulisten.

Wenn Sie Gemini Code Assist einrichten, fahren Sie mit den Schritten unter Codeanpassung für Gemini Code Assist konfigurieren und verwenden fort.

Datenfreigabe

Inhalte von Google Cloud Ressourcen, die mit dieser Verbindung verknüpft sind, werden möglicherweise an GitHub übertragen. Diese Aussage gilt für alle vorhandenen und zukünftigen Ressourcen, die diese Verbindung nutzen. Wenn Sie keine Informationen mehr mit GitHub teilen möchten, löschen Sie die Developer Connect-Verbindungen in der Google Cloud Console oder der gcloud CLI und widerrufen Sie den Zugriff in GitHub.

Nächste Schritte