GitHub 的企业服务器示例 CodeBuild - Amazon CodeBuild
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

GitHub 的企业服务器示例 CodeBuild

Amazon CodeBuild支持将 GitHub 企业服务器作为源存储库。此示例显示了在 GitHub 企业服务器存储库安装了证书时如何设置 CodeBuild 项目。它还说明如何启用 Webhook 以在每次将代码更改推送到您的 GitHub 企业服务器存储库时 CodeBuild 重新构建源代码。

先决条件

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

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

  2. 从 GitHub 企业服务器下载您的证书。 CodeBuild 使用证书与存储库建立可信 SSL 连接。

    Linux/macOS 客户端:

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

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

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

    HOST。您的 GitHub 企业服务器存储库的 IP 地址。

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

    folder。下载证书的文件夹。

    filename。证书文件的文件名。

    重要

    将证书另存为 .pem 文件。

    Windows 客户端:

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

    重要

    将证书另存为 .pem 文件。

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

    注意

    此存储桶必须与您的构建位于同一Amazon区域。例如,如果您指示 CodeBuild 在美国东部(俄亥俄州)区域运行构建项目,则该存储桶必须位于美国东部(俄亥俄州)区域。

使用 GitHub企业服务器作为源存储库创建构建项目并启用 webhooks(控制台)

  1. 通过 https://console.aws.amazon.com/codesuite/codebuild/home 打开Amazon CodeBuild主机。

  2. 如果显示 CodeBuild 信息页面,请选择创建生成项目。否则,在导航窗格上,展开 “构建”,选择 “生成项目”,然后选择 “创建生成项目”。

  3. Project name (项目名称),输入此构建项目的名称。构建项目名称在您的各个 Amazon 账户内必须是唯一的。您还可以添加构建项目的可选描述,以帮助其他用户了解该项目的用途。

  4. 源代码源提供者中,选择GitHub 企业

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

      注意

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

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

    • 展开 Additional configuration (其他配置)

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

    • 选择 “启用不安全 SSL” 可在连接到 GitHub 企业服务器项目存储库时忽略 SSL 警告。

      注意

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

  5. Environment (环境) 中:

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

    • 要使用由 Amazon CodeBuild 托管的 Docker 映像,请选择 Managed image (托管映像),然后从 Operating system (操作系统)Runtime(s) (运行时)Image (映像) 以及 Image version (映像版本) 中进行相应选择。从 Environment type (环境类型) 中进行选择(如果可用)。

    • 要使用其他 Docker 映像,请选择 Custom image (自定义映像)。对于环境类型,选择 ARMLinux、Lin ux GPUWindows。如果您选择 “其他注册表”,则在外部注册表 URL 中,使用格式输入 Docker Hub 中 Docker 映像的名称和标签docker repository/docker image name。如果您选择 Amazon ECR,请使用亚马逊 ECR 存储库亚马逊 ECR 镜像在您的Amazon账户中选择 Docker 镜像。

    • 要使用私有 Docker 镜像,请选择自定义镜像。对于环境类型,选择 ARMLinux、Lin ux GPUWindows。对于 Image registry (映像注册表),选择 Other registry (其他注册表),然后输入您的私有 Docker 映像的凭证的 ARN。证书必须由Secrets Manager 创建。有关更多信息,请参阅什么是Amazon Secrets Manager? Amazon Secrets Manager用户指南中。

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

    • 如果您没有 CodeBuild 服务角色,请选择新建服务角色。在 Role name 中,为新角色输入名称。

    • 如果您有 CodeBuild 服务角色,请选择现有服务角色。在角色 ARN 中,选择服务角色。

    注意

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

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

    如果您 CodeBuild 想使用您的 VPC:

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

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

    • 对于 VPC 安全组,选择 CodeBuild 用于允许访问 VPC 中资源的安全组。

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

  8. Buildspec 中,执行操作之一:

    • 选择 “使用 buildspec 文件” 以使用源代码根目录中的 buildspec.yml 文件。

    • 选择 “插入生成命令” 以使用控制台插入生成命令。

    有关更多信息,请参阅 构建规范参考

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

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

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

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

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

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

  10. 对于 Cache type (缓存类型),请选择下列选项之一:

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

    • 如果您想使用 Amazon S3 缓存,请选择 Amazon S3,然后执行以下操作:

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

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

        重要

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

    • 如果想要使用本地缓存,请选择 Local (本地),然后选择一个或多个本地缓存模式。

      注意

      Docker 层缓存模式仅适用于 Linux。如果您选择该模式,您的项目必须在特权模式下运行。

    使用缓存可节省大量构建时间,因为构建环境的可重用部分被存储在缓存中,并且可跨构建使用。有关在构建规范文件中指定缓存的信息,请参阅构建规范语法。有关缓存的更多信息,请参阅在 Amazon CodeBuild 中构建缓存

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

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

    重要

    Create webhook 对话框只出现一次。请复制负载 URL 和私有密钥。在 GitHub 企业服务器中添加 webhook 时需要它们。

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

  13. 在 E GitHub nterprise Server 中,选择存储 CodeBuild 项目的存储库。

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

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

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