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 über die Google Cloud Console, oder die 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 Codevorschläge von Gemini Code Assist erhalten, die auf Ihre Codebasis zugeschnitten sind, oder Ihre verknüpften GitHub-Repositories verwenden, um Webanwendungen mit Firebase App Hosting zu entwickeln.

Weitere Informationen finden Sie unter Developer Connect.

Hinweis

  1. Melden Sie sich bei 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. Achten Sie darauf, dass Sie Zugriff auf ein Konto auf GitHub. haben.

    Um die Arbeit Ihres Teams zu schützen, empfehlen wir, die Aufgaben in dieser Anleitung mit einem Bot-Konto oder einem von Ihrem Team gemeinsam genutzten Konto auszuführen und nicht mit einem persönlichen Konto.

  9. Achten Sie darauf, dass Sie Inhaber eines GitHub-Repositorys sind oder Administratorberechtigungen 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 dieser Anleitung 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 nutzen. Führen Sie dazu gcloud components update aus.
    2. Erstellen Sie ein Developer Connect-Dienstkonto mit dem folgenden Befehl. 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 verwenden möchten, um die von Developer Connect erstellten Secrets zu verschlüsseln: Cloud KMS CryptoKey-Verschlüsseler/Entschlüsseler (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: Secret Manager-Administratorrolle (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: Projekt-IAM-Administrator (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 Console verwenden, können Sie auch Links zu Repositories hinzufügen, sobald Sie die Einrichtung der Verbindung abgeschlossen haben.

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

Console

Führen Sie die folgenden Schritte aus, um eine Verbindung herzustellen:

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

    Zu Developer Connect

    In Developer Connect wird die Seite Git-Repositories angezeigt.

    • Wenn eine Liste von Quellcode-Verwaltungsanbietern angezeigt wird: Starten Sie die Konfiguration Ihrer ersten Verbindung, indem Sie einen Quellcode- Verwaltungsanbieter auswählen. Klicken Sie auf der GitHub-Karte auf Verbinden.

    • Wenn eine Tabelle mit vorhandenen Verbindungen angezeigt wird: Legen Sie den Quellcode-Verwaltungsanbieter 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. In diesem Fall erstellt Developer Connect eine GitHub-Anwendung.

    Wenn Sie GitHub-Verbindungen mit der Google Cloud CLI erstellen, entsprechen diese Verbindungen nicht den Anforderungen an den Datenstandort. 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-Anwendung Zugriff auf Ihr GitHub-Konto zu gewähren.

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

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

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

    2. Klicken Sie auf GitHub-Anwendung erstellen.

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

    4. Wählen Sie die Repositories aus, für die die GitHub-Anwendung 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 Ihrem Google 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-Anwendung, die Sie auf der Seite Verbindungsdetails verwalten können. Klicken Sie dazu auf Installation verwalten.

Verbindung konfigurieren

Die folgenden Schritte sind erforderlich, wenn Sie das Kästchen Datenstandortkonforme Verbindung 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-Anwendung bereits im GitHub-Konto installiert ist.

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

Wenn eine Liste von GitHub-Konten angezeigt wird, installieren Sie die Anwendung und verknüpfen Sie Repositories. Führen Sie dazu die folgenden Schritte aus:

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

  2. Wählen Sie ein oder mehrere Repositories aus, für die Sie Zugriff gewähren möchten.

Wenn Sie aufgefordert werden, eine vorhandene App-Installation wiederzuverwenden, wählen Sie aus, wo Sie die App konfigurieren möchten. Führen Sie dazu die folgenden Schritte aus:

  1. Klicken Sie auf GitHub-Konto , um Konten aufzurufen, in denen die Google Developer Connect-Anwendung installiert ist. Wenn das gewünschte Konto angezeigt wird, wählen Sie es aus, indem Sie auf Bestätigen klicken.

  2. Wenn das gewünschte Konto nicht angezeigt wird, 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 Anleitung von GitHub, um die Installation der Anwendung zuzulassen.

    3. Wählen Sie ein oder mehrere Repositories aus, für die Sie Zugriff gewähren möchten.

Wenn das Dialogfeld geschlossen wird, ist die Installation der Anwendung abgeschlossen.

Sobald die Verbindung hergestellt 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 und Ihre Repository Links der Seite Repositories in der Google Cloud Console hinzugefügt. Sie können jederzeit weitere Links zu vorhandenen Verbindungen hinzufügen.

Wenn Sie Gemini Code Assist einrichten, fahren Sie mit dem Prozess fort indem Sie die Schritte unter Codeanpassung für Gemini Code Assist konfigurieren und verwendenbefolgen.

gcloud

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

Führen Sie die folgenden Schritte aus, um eine Verbindung herzustellen:

  1. Führen Sie den gcloud developer-connect connections create Befehl 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 Ihrer Verbindung.
    • REGION: die Region für Ihre Verbindung.
    • APP_TYPE: der Typ der Anwendung, die in GitHub installiert werden soll: entweder DEVELOPER-CONNECT zur Verwendung mit Gemini Code Assist oder FIREBASE zur Verwendung mit Firebase App Hosting.
    • --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.

    Ein Verbindungsname wird erstellt.

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

    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 Link zurück, mit dem 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-Anwendung Zugriff auf Ihr GitHub-Konto zu gewähren.

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

GitHub erstellt ein Token und Developer Connect speichert es in Ihrem Google 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-Anwendung, die Sie auf der Seite Verbindungsdetails verwalten können. Klicken Sie dazu auf Installation verwalten.

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-Anwendung bereits im GitHub-Konto installiert ist.

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

Wenn eine Liste von GitHub-Konten angezeigt wird, installieren Sie die Anwendung und verknüpfen Sie Repositories. Führen Sie dazu die folgenden Schritte aus:

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

  2. Wählen Sie ein oder mehrere Repositories aus, für die Sie Zugriff gewähren möchten.

Wenn Sie aufgefordert werden, eine vorhandene App-Installation wiederzuverwenden, wählen Sie aus, wo Sie die App konfigurieren möchten. Führen Sie dazu die folgenden Schritte aus:

  1. Klicken Sie auf GitHub-Konto , um Konten aufzurufen, in denen die Google Developer Connect-Anwendung installiert ist. Wenn das gewünschte Konto angezeigt wird, wählen Sie es aus, indem Sie auf Bestätigen klicken.

  2. Wenn das gewünschte Konto nicht angezeigt wird, 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 Anleitung von GitHub, um die Installation der Anwendung zuzulassen.

    3. Wählen Sie ein oder mehrere Repositories aus, für die Sie Zugriff gewähren möchten.

Wenn das Dialogfeld geschlossen wird, ist die Installation der Anwendung abgeschlossen.

Verbindung prüfen

Prüfen Sie die Erstellung Ihrer 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 der Anwendung abgeschlossen. Andernfalls gibt Developer Connect eine URI zurück, mit der Sie zur Konfiguration im Browser zurückkehren können.

Sobald die Verbindung hergestellt wurde, wählen Sie aus, welche Repositories verknüpft werden sollen. Folgen Sie dazu der Anleitung unter Repository-Links zu vorhandenen Verbindungen hinzufügen.

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

Wählen Sie eine der folgenden Optionen aus, um Repository-Links für eine vorhandene GitHub-Verbindung zu erstellen:

Console

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

    Seite „Repositories“ öffnen

  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 Liste der Repositories 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 Console 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.

Developer Connect erstellt die Repository-Links.

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

Wenn Sie Gemini Code Assist einrichten, fahren Sie mit dem Prozess fort indem Sie die Schritte unter Codeanpassung für Gemini Code Assist konfigurieren und verwendenbefolgen.

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 für GitHub freigeben möchten, löschen Sie Developer Connect-Verbindungen in der Google Cloud Console oder der gcloud CLI und widerrufen Sie den Zugriff in GitHub.

Nächste Schritte