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

使用 CodeBuild 构建徽章示例

AWS CodeBuild 现在支持使用构建徽章,该徽章提供一个动态生成的可嵌入映像(徽章),用以显示项目的最新构建状态。可通过为您的 CodeBuild 项目生成的公开可用的 URL 访问此映像。这将允许任何人查看 CodeBuild 项目的状态。构建徽章不包含任何安全信息,因此它们无需身份验证。

创建已启用构建徽章的构建项目 (控制台)

  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 (源提供商),选择源提供商类型,然后执行以下操作之一:

    • 如果您选择了 Amazon S3,那么对于 Bucket (存储桶),请选择包含源代码的输入存储桶的名称。对于 S3 object key (S3 对象键),请输入包含源代码的 ZIP 文件的名称。

    • 如果您选择了 CodeCommit,那么对于 Repository (存储库),请选择存储库的名称。选择 Enable build badge (启用生成徽章),以使您的项目的生成状态可见且可嵌入。

    • 如果您选择了 GitHub,请按照说明与 GitHub 连接 (或重新连接)。在 GitHub Authorize application (授权应用程序) 页面上,对于 Organization access (组织访问权限),选择您希望 AWS CodeBuild 能够访问的每个存储库旁边的 Request access (请求访问权限)。选择 Authorize application (授权应用程序) 后,返回 AWS CodeBuild 控制台,对于 Repository (存储库),选择包含源代码的存储库的名称。选择 Enable build badge (启用生成徽章),以使您的项目的生成状态可见且可嵌入。

    • 如果您选择了 Bitbucket,请按照说明与 Bitbucket 连接 (或重新连接)。在 Bitbucket Confirm access to your account 页面上,对于 Organization access,选择 Grant access。选择 Grant access (授予访问权限) 后,返回 AWS CodeBuild 控制台,对于 Repository (存储库),选择包含源代码的存储库的名称。选择 Enable build badge (启用生成徽章),以使您的项目的生成状态可见且可嵌入。

      重要

      更新项目源可能会影响项目构建徽章的准确性。

  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. 对于 Buildspec,执行以下操作之一:

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

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

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

  8. 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 的描述。

  9. 展开 Additional configuration (其他配置) 并根据需要设置选项。

  10. 选择 Create build project (创建构建项目)。在 Review (审核) 页面上,选择 Start build (启动构建) 以运行构建。

创建已启用构建徽章的构建项目 (CLI)

有关创建构建项目的信息,请参阅创建构建项目 (AWS CLI)。要在您的 AWS CodeBuild 项目中包含构建徽章,您必须指定值为 truebadgeEnabled

访问您的 AWS CodeBuild 构建徽章

您可以使用 AWS CodeBuild 控制台或 AWS CLI 访问构建徽章。

  • 在 CodeBuild 控制台中,在生成项目列表中的 Name (名称) 列,选择与生成项目相对应的链接。在 Build project: project-name (构建项目: 项目名称) 页面上的 Configuration (配置) 中,选择 Copy badge URL (复制徽章 URL)。有关更多信息,请参阅查看构建项目的详细信息 (控制台)

  • 在 AWS CLI 中,运行 batch-get-projects 命令。构建徽章 URL 包含在输出的项目环境详细信息部分中。有关更多信息,请参阅 查看构建项目的详细信息 (AWS CLI)

重要

给定生成徽章请求 URL 适用于主分支,但您可以指定源存储库中已用于运行生成的任何分支。

发布您的 CodeBuild 构建徽章

您可以将生成徽章请求 URL 包含在您的首选存储库(例如,GitHub 或 CodeCommit)中的 markdown 文件中以显示最新生成的状态。

示例 markdown 代码:

![Build Status](https://codebuild.us-east-1.amazon.com/badges?uuid=...&branch=master)

CodeBuild 徽章状态

  • PASSING 给定分支上的最新构建已传递。

  • FAILING 给定分支上的最新构建已超时、失败、出现故障或停止。

  • IN_PROGRESS 给定分支上的最新构建正在进行中。

  • UNKNOWN 项目尚未为给定分支运行构建或根本未运行。此外,构建徽章功能可能已禁用。