AWS CodeBuild
用户指南 (API 版本 2016-10-06)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

适用于 CodeBuild 的 GitHub Enterprise 示例

AWS CodeBuild 支持将 GitHub Enterprise 作为源存储库。此示例演示在 GitHub Enterprise 存储库安装证书后,如何设置您的 CodeBuild 项目。它还演示了如何启用 Webhook,这样在每次代码更改推送到您的 GitHub Enterprise 存储库后,CodeBuild 都可以重新构建源代码。

先决条件

  1. 为您的 CodeBuild 项目生成个人访问令牌。我们建议您创建一个 GitHub Enterprise 用户,并为该用户生成个人访问令牌。将它复制到您的剪贴板,以便在创建 CodeBuild 项目时使用。有关更多信息,请参阅 GitHub 帮助网站上的在 GitHub Enterprise 中创建个人访问令牌

    在创建个人访问令牌时,请在定义中包含存储库范围。

  2. 从 GitHub Enterprise 下载您的证书。CodeBuild 使用此证书与存储库建立可信 SSL 连接。

    Linux/macOS 客户端:

    从您的 终端窗口中运行以下命令:

    echo -n | openssl s_client -connect HOST:PORTNUMBER \ | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > /folder/filename.pem

    将命令中的占位符替换为以下值:

    HOST。您的 GitHub Enterprise 存储库的 IP 地址。

    PORTNUMBER。用于连接的端口号 (例如,443)。

    folder。下载证书的文件夹。

    filename。证书文件的文件名。

    重要

    将证书另存为 .pem 文件。

    Windows 客户端:

    使用浏览器从 GitHub Enterprise 下载您的证书。要查看站点的证书详细信息,请选择挂锁图标。有关如何导出证书的信息,请参阅浏览器文档。

    重要

    将证书另存为 .pem 文件。

  3. 将您的证书文件上传到 Amazon S3 存储桶。有关如何创建 Amazon S3 存储桶的信息,请参阅如何创建 Amazon S3 存储桶? 有关如何将对象上传到 Amazon S3 存储桶的信息,请参阅如何将文件和文件夹上传至存储桶?

    注意

    此存储桶必须与您的构建项目处在同一个 AWS 区域中。例如,如果您指示 CodeBuild 在美国东部(俄亥俄)区域运行生成任务,则存储桶也必须位于美国东部(俄亥俄)区域中。

创建将 GitHub Enterprise 作为源存储库的构建项目,并启用 Webhook (控制台)

  1. Open the AWS CodeBuild console at https://console.amazonaws.cn/codesuite/codebuild/home.

  2. 如果显示 CodeBuild 信息页面,请选择 Create build project (创建构建项目)。否则,请在导航窗格上展开 Build (构建),然后依次选择 Build projects (构建项目)Create build project (创建构建项目)

  3. Create build project (创建构建项目) 页面上的 Project configuration (项目配置) 中,对于 Project name (项目名称),输入此构建项目的名称。构建项目名称在您的各个 AWS 账户内必须是唯一的。您也可以包含构建项目的可选描述来帮助其他用户了解此项目的用途。

  4. Source (源)Source provider (源提供商) 中,选择 GitHub Enterprise

    • 对于 Personal Access Token,粘贴您复制到剪贴板的令牌,然后选择 Save Token。在 Repository URL 中输入您的 GitHub Enterprise 存储库的 URL。

      注意

      您只需输入并保存一次个人访问令牌。未来所有 AWS CodeBuild 项目均会使用此令牌。

    • Repository URL (存储库 URL) 中,输入您的存储库的路径,包括存储库的名称。

    • 展开 Additional configuration (其他配置)

    • 选择 Rebuild every time a code change is pushed to this repository (每次将代码推送到此存储库时都会重建) 以便每次将代码推送到此存储库时进行重建。

    • 选择 Enable insecure SSL (启用不安全的 SSL),在连接到您的 GitHub Enterprise 项目存储库时忽略 SSL 警告。

      注意

      建议您仅将 Enable insecure SSL (启用不安全的 SSL) 用于测试。它不应在生产环境中使用。

  5. Environment (环境) 中:

    对于 Environment image (环境映像),执行下列操作之一:

    • 要使用由 AWS CodeBuild 托管的 Docker 映像,请选择 Managed image (托管映像),然后从 Operating system (操作系统)Runtime (运行时)Runtime version (运行时版本) 中进行相应选择。

    • 要使用其他 Docker 映像,请选择 Custom image (自定义映像)。对于 Environment type (环境类型),选择 LinuxWindows。对于 Custom image type (自定义映像类型),选择 Amazon ECROther location (其他位置)。如果您选择 Other location (其他位置),请在 Docker Hub 中按照格式 docker repository/docker image name 输入 Docker 映像的名称和标签。如果您选择 Amazon ECR,请使用 Amazon ECR repository (Amazon ECR 存储库)Amazon ECR image (Amazon ECR 映像) 在您的 AWS 账户中选择 Docker 映像。

    • 要使用私有 Docker 映像,请选择 Custom image (自定义映像)。对于 Environment type (环境类型),选择 LinuxWindows。对于 Custom image type (自定义映像类型),选择 Other location (其他位置),然后输入您私有 Docker 映像的凭证的 Amazon 资源名称 (ARN)。凭证必须由 AWS Secrets Manager 创建。有关更多信息,请参阅什么是 AWS Secrets Manager?

  6. Service role (服务角色) 中,执行下列操作之一:

    • 如果您没有 CodeBuild 服务角色,请选择 New service role (新建服务角色)。在 Role name (角色名称) 中,接受默认名称或输入您自己的名称。

    • 如果您有 CodeBuild 服务角色,请选择 Existing service role (现有服务角色)。在 Role name (角色名称) 中,选择服务角色。

    注意

    当您使用控制台来创建或更新生成项目时,您可以同时创建 CodeBuild 服务角色。默认情况下,这个角色仅能与该构建项目配合使用。如果您使用控制台将此服务角色与另一个构建项目关联,则此角色将更新以便与关联的构建项目结合使用。一个服务角色最多可与 10 个构建项目结合使用。

  7. 展开 Additional configuration (其他配置)

    VPC 中,执行下列操作之一:

    • 如果您没有将 VPC 用于项目,请选择 No VPC (无 VPC)

    • 如果要将 CodeBuild 与您的 VPC 结合使用:

      • 对于 VPC,选择 CodeBuild 使用的 VPC ID。

      • 对于 VPC Subnets (VPC 子网),选择包含 CodeBuild 使用的资源的子网。

      • 对于 VPC Security groups (VPC 安全组),选择 CodeBuild 用来支持对 VPC 中资源的访问的安全组。

    有关更多信息,请参阅 将 CodeBuild 与 Amazon Virtual Private Cloud 结合使用

  8. 对于 Buildspec,执行以下操作之一:

    • 选择 Use a buildspec file (使用 buildspec 文件) 以在源代码根目录中使用 buildspec.yml 文件。

    • 选择 Insert build commands (插入构建命令) 以使用控制台插入构建命令。

    有关更多信息,请参见 生成规范参考

  9. Artifacts (构件) 中,对于 Type (类型),执行以下操作之一:

    • 如果您不想创建任何构建输出项目,请选择 No artifacts (无构件)

    • 要将构建输出存储在 Amazon S3 存储桶中,请选择 Amazon S3,然后执行以下操作:

      • 如果要将项目名称用于构建输出 ZIP 文件或文件夹,请将 Name (名称) 留空。否则,请输入名称。默认情况下,构件名称是项目名称。如果您要使用其他名称,请在构件名称框中输入该名称。如果您要输出 ZIP 文件,请包含 zip 扩展名。

      • 对于 Bucket name (存储桶名称),请选择输出存储桶的名称。

      • 如果您在此过程的前面部分选择了 Insert build commands (插入生成命令),那么对于 Output files (输出文件),请输入生成(该生成要放到生成输出 ZIP 文件或文件夹中)中的文件位置。对于多个位置,使用逗号分开各个位置 (appspec.yml, target/my-app.jar)。有关更多信息,请参阅 生成规范语法files 的描述。

  10. 展开 Additional configuration (其他配置)。在 Cache type (缓存类型) 中,执行下列操作之一:

    • 如果您不想使用缓存,请选择 No cache (无缓存)

    • 要使用缓存,请选择 Amazon S3,然后执行下列操作:

      • 对于 Cache bucket (缓存存储桶),选择存储缓存的 Amazon S3 存储桶的名称。

      • (可选)对于 Cache path prefix (缓存路径前缀),输入 Amazon S3 路径前缀。Cache path prefix (缓存路径前缀) 值类似于目录名称。它使您能够在存储桶的同一目录下存储缓存。

        重要

        请勿将一个尾斜杆 (/) 附加到路径前缀后面。

    使用缓存可节省大量构建时间,因为构建环境的可重用部分被存储在缓存中,并且可跨构建使用。

  11. 选择 Create build project (创建构建项目)。在生成项目页面上,选择 Start build (开始生成)

  12. 如果您在 Source (源) 中启用了 Webhook,将出现 Create webhook (创建 webhook) 对话框,其中显示 Payload URL (负载 URL)Secret (密钥) 的值。

    重要

    Create webhook 对话框只出现一次。请复制负载 URL 和私有密钥。在 GitHub Enterprise 中添加 Webhook 时会用到它们。

    如果您需要再次生成负载 URL 和私有密钥,必须首先删除 GitHub Enterprise 存储库中的 Webhook。在您的 CodeBuild 项目中,清除 Webhook 复选框,然后选择 Save (保存)。然后您可以在创建或更新 CodeBuild 项目时选中 Webhook 复选框。Create webhook (创建 webhook) 对话框将再次出现。

  13. 在 GitHub Enterprise 中,选择存储您 CodeBuild 项目的存储库。

  14. 选择 Settings (设置),选择 Hooks & services (挂钩和服务),然后选择 Add webhook (添加 webhook)

  15. 输入负载 URL 和私有密钥,接受其他字段的默认值,然后选择 Add webhook

  16. 返回您的 CodeBuild 项目。关闭 Create webhook 对话框,然后选择 Start build