从 Bitbucket Server 构建代码库

借助 Cloud Build,您可以创建用于构建作业的触发器 Bitbucket Server 上托管的代码库,让您能够执行构建以响应事件,例如与您的 Bitbucket Server 代码库关联的提交推送或拉取请求。

本页面介绍了如何在 Bitbucket Server 实例上启用触发器功能。

准备工作

  • Enable the Cloud Build, Secret Manager, and Compute Engine APIs.

    Enable the APIs

创建 Bitbucket Server 触发器

本部分介绍如何连接 Bitbucket Server 代码库 并创建一个触发器来自动调用 构建应用如果要在专用网络中使用 Bitbucket Server 触发器,请参阅在专用网络中构建来自 Bitbucket Server 的代码库,了解详细说明。

控制台

如需使用 Google Cloud 控制台创建 Bitbucket Server 触发器,请执行以下操作:

  1. 打开触发器页面

    打开“触发器”页面

  2. 从页面顶部选择您的项目,然后点击打开

  3. 点击创建触发器

  4. 输入以下触发器设置:

    • 名称:触发器的名称。

    • 区域:为触发器选择区域

      • 如果您选择全球作为区域, Cloud Build 使用 运行 build。
      • 如果您选择的是非全球区域, 与触发器关联的构建配置文件 指定专用池时,Cloud Build 会使用专用池 运行 build。在这种情况下,您在触发器中指定的区域必须与创建专用池的区域一致。
      • 如果您选择非全球区域,并且与触发器关联的构建配置文件指定专用池,Cloud Build 会使用默认池在与触发器相同的区域中运行您的构建。
    • 说明(可选):触发器的说明。

    • 事件:选择用于调用触发器的代码库事件。

      • 推送到分支:设置触发器,以便基于对特定分支的提交启动构建。

      • 推送新标记:将触发器设置为以基于包含特定标记的提交启动构建。

      • 拉取请求:设置触发器以启动构建 拉取请求的提交

    • 来源:选择第 1 代作为来源。

      • 代码库:从可用代码库列表中,选择一个 存储库如需关联新的代码库,请参阅 连接到 Bitbucket Server 代码库

      • 分支标记:指定包含分支或 标记值相匹配。

      • 评论控制:如果您选择了拉取请求作为事件,则可以选择设置来控制非评论事件是否需要额外的互动才能触发构建。选择下列选项之一,以控制是否将 构建作业将由触发器自动执行:

        • (所有者和协作者除外):拉取 请求由代码库所有者或用户创建或更新 具有写入权限,那么构建将由 触发器。如果相应操作是由外部贡献者发起的, 只有在所有者或用户拥有访问权限的情况下, 权限备注。针对拉取请求添加 /gcbrun 注释。请参阅 COMMENTS_ENABLED_FOR_EXTERNAL_CONTRIBUTORS_ONLY

        • 必需:如果具有写入权限的用户创建拉取请求并在拉取请求说明中添加 /gcbrun,系统会在创建拉取请求时运行 build。当拉取请求被触发时 任何其他贡献者创建或更新的版本 在所有者或具有写入权限的用户之后执行 针对拉取请求的 /gcbrun 权限。 请参阅 COMMENTS_ENABLED

        • 非必需: 任何贡献者,构建都会由 触发器。 请参阅 COMMENTS_DISABLED

        在 Bitbucket Server 中,非注释事件包括 打开、修改和批准拉取请求。

        评论事件(包括添加、修改和删除评论)只有在评论来自具有写入权限或更高权限的用户,并且评论包含 /gcbrun 时才会触发 build。

        如需详细了解 Bitbucket Server 事件类型,请参阅 Bitbucket 文档中的管理 Webhook

    • 配置:选择位于您的代码库中的构建配置文件,或在触发器上以内嵌方式配置构建。

    • 类型:选择要用于构建的配置类型。

      • Cloud Build 配置文件(yaml 或 json):为您的配置使用构建配置文件。
      • Dockerfile:为您的配置使用 Dockerfile
    • 位置:为您的配置指定位置。

      • 代码库:如果您的配置文件位于 请提供您的 构建配置文件Dockerfile 目录和所生成映像的名称。如果您的配置是 Dockerfile,则还可以选择提供构建的超时时间。提供了 Dockerfile 和映像名称后,您会看到构建将执行的 docker build 命令的预览。

      • 内嵌:如果您选择了 Cloud Build 配置文件(yaml 或 json)作为配置选项,则可以指定内嵌构建配置。点击 Open Editor(打开编辑器),在 使用 YAML 或 JSON 语法创建 Google Cloud 控制台。点击完成以保存您的构建配置。

  5. 点击创建以创建 Bitbucket Server 触发器。

gcloud

如需使用 gcloud 命令创建 Bitbucket Server 触发器,您需要在终端中运行以下 gcloud builds triggers create bitbucketserver 命令:

gcloud builds triggers create bitbucketserver
    --name=TRIGGER_NAME \
    --project-key=PROJECT_KEY \
    --repo-slug=REPO_SLUG \
    --bitbucket-server-config-resource=projects/PROJECT_NUMBER/locations/REGION/bitbucketServerConfigs/ID \
    --branch-pattern=BRANCH_NAME \ # --tag-pattern=TAG_NAME
    --build-config=BUILD_CONFIG

其中:

  • TRIGGER_NAME 是触发器的名称。
  • PROJECT_KEY 是 Bitbucket Server 项目的密钥。PROJECT_KEY 区分大小写。
  • REPO_SLUG 是 Bitbucket Server 代码库的 Slug。如需了解详情,请参阅 Bitbucket 的代码库 Slug 指南
  • PROJECT_NUMBER 是您的 Cloud 项目的项目编号。
  • REGION 是与您的 Bitbucket Server 配置关联的区域
  • ID 是您的 BitbucketServerConfig 的 ID。
  • BRANCH_NAME 是一个与您的分支匹配的正则表达式(如果需要的话) 设置触发器来构建特定分支。
  • TAG_NAME 是与您的标记匹配的正则表达式(如果您想将 来构建特定代码
  • BUILD_CONFIG 是构建配置文件的路径。

API

如需使用 API 创建 Bitbucket Server 触发器,请使用以下 JSON 模板。

{
    "filename": "cloudbuild.yaml",
    "name": "curl-trigger",
    "description": "curl trigger",
    "bitbucket_server_trigger_config": {
        "repo_slug": "REPO_SLUG",
        "project_key": "PROJECT_KEY",
        "push": {
            "branch": "BRANCH_NAME" # "tag": "TAG_NAME"
        },
        "bitbucket_server_config_resource": "projects/PROJECT_NUMBER/locations/REGION/bitbucketServerConfigs/ID"
        "comment_control": "COMMENT_SETTING"
    }
}

其中:

  • REPO_SLUG 是 Bitbucket Server 代码库的 Slug。如需了解详情,请参阅 Bitbucket 的代码库 Slug 指南
  • PROJECT_KEY 是 Bitbucket Server 项目的密钥。PROJECT_KEY 区分大小写。
  • BRANCH_NAME 是分支的正则表达式(如果需要的话) 设置触发器来构建特定分支。
  • TAG_NAME 是代码的正则表达式(如果您要设置 来构建特定代码
  • PROJECT_NUMBER 是您的 Cloud 项目的项目编号。
  • REGION 是与您的 Bitbucket Server 配置关联的区域
  • ID 是您的 BitbucketServerConfig 的 ID。
  • COMMENT_SETTING 是一项设置,用于控制构建触发器是否需要在注释中包含 /gcbrun 才能运行构建。有关 信息,请参阅 commentControl

在终端中输入以下 curl 命令:

curl -X POST -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8" -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/triggers -d @trigger.json

其中:

  • PROJECT_NUMBER 是您的 Google Cloud 项目编号。
  • PROJECT_ID 是您的 Google Cloud 项目 ID。

数据共享

从 Cloud Build 发送到 Bitbucket Server 的数据可帮助您按名称识别触发器,并查看 Bitbucket Server 上的构建结果。

以下数据在 Cloud Build 和 Bitbucket Server 之间共享:

  • Google Cloud 项目 ID
  • 触发器名称

系统会自动为 Bitbucket Server 启用数据共享。

后续步骤