关联到 GitHub

本页介绍了如何创建与 GitHub 的连接，以及如何创建指向 GitHub 代码库的链接。您可以使用 Google Cloud 控制台或 Google Cloud CLI 完成这些任务。

以下说明适用于希望将 GitHub 源代码库与 Google 搭配使用的应用开发者、平台管理员和安全经理。

例如，您可以从 Gemini Code Assist 获取根据您的代码库量身定制的编码建议，也可以使用关联的 GitHub 代码库通过 Firebase App Hosting 开发 Web 应用。

如需详细了解 Developer Connect，请参阅 Developer Connect 概览。

准备工作

  1. 登录您的 Google 账号。

    如果您还没有 Google 账号，请注册新账号。

  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 serviceusage.services.enable permission. 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.

    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 serviceusage.services.enable permission. 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.

    Enable the API

    8.

    启用 Developer Connect 也会启用 Secret Manager API。

  8. 确保您有权访问 GitHub 上的账号。

    为确保团队工作的安全性，我们建议您使用机器人账号或团队共享的账号（而非个人账号）完成本指南中的任务。

  9. 确保您拥有 GitHub 代码库，或者对共享代码库具有管理员级别的权限。
  10. 可选：创建客户管理的加密密钥 (CMEK)，用于加密 Developer Connect 创建的身份验证 Secret。
  11. 可选：如需使用本指南中的命令行说明，请完成以下步骤：
    1. 安装 Google Cloud CLI。 如果您之前已经安装了 gcloud CLI，请运行 gcloud components update 以确保您拥有最新版本。
    2. 运行以下命令，创建Developer Connect 服务账号，其中 PROJECT_ID 是您的Google Cloud 项目 ID：
              gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID

所需的角色

如需获得创建连接和关联所需的权限，请让您的管理员为您授予以下 IAM 角色：

  • 如果您不是项目所有者，则需要为您的用户账号授予 Developer Connect Admin (roles/developerconnect.admin) 角色。
  • 如果您计划使用 CMEK 加密 Developer Connect 创建的 Secret，请在 Secret Manager 服务账号上授予 Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter) 角色。
  • 如果您计划使用 gcloud CLI 完成本指南中的步骤： Developer Connect 服务账号的 Secret Manager Admin 角色 (roles/secretmanager.admin)。
  • 如果您计划使用 Google Cloud 控制台完成本指南中的步骤，则需要： 您的用户账号的 Project IAM Admin (roles/resourcemanager.projectIamAdmin) 角色。

如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

您也可以通过自定义角色或其他预定义角色来获取所需的权限。

创建连接

本部分介绍了如何在 Developer Connect 与 GitHub 之间建立连接。如果您使用的是 Google Cloud 控制台，则还可以在完成连接设置后开始添加指向代码库的链接。

如需创建新的 GitHub 连接，请选择以下选项之一：

控制台

如需发起连接，请完成以下步骤：

  1. 在 Google Cloud 控制台中，打开 Developer Connect。