Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

在 Amazon CodeBuild 中创建构建项目

您可以使用 Amazon CodeBuild 控制台、Amazon CLI 或 Amazon 开发工具包创建构建项目。

先决条件

在创建构建项目之前，请回答计划构建中的问题。

创建构建项目（控制台）

从 https://console.aws.amazon.com/codesuite/codebuild/home 打开 Amazon CodeBuild 控制台。

如果显示了 CodeBuild 信息页面，请选择创建构建项目。否则，请在导航窗格中，展开构建，选择构建项目，然后选择创建构建项目。

选择创建构建项目。

填写以下部分：完成后，选择页面底部的创建构建项目。

项目配置

来源

Amazon S3

存储桶

选择包含源代码的输入存储桶的名称。

S3 对象密钥或 S3 文件夹

输入 ZIP 文件的名称或包含源代码的文件夹的路径。

源版本

输入表示输入文件版本的对象的版本 ID。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

CodeCommit

存储库

选择要使用的存储库。

参考类型

选择分支、Git 标签或提交 ID，以指定源代码的版本。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

注意

我们建议您选择看起来不像提交 ID 的 Git 分支名称，例如 811dd1ba1aba14473856cee38308caed7190c0d 或 5392f7。这可以帮助您避免 Git 签出与实际提交发生冲突。

Git 克隆深度

选择该选项，以创建一个浅克隆，其历史记录会截断至指定数量的提交。如果您需要完整克隆，请选择完整。

Git 子模块

如果您希望在存储库中包含 Git 子模块，请选择使用 Git 子模块。

Bitbucket

凭证

选择默认来源凭证或自定义来源凭证，然后按照说明管理默认来源凭证或自定义源凭证。

连接类型

选择 CodeConnections、OAuth、应用程序密码或个人访问令牌以连接到 CodeBuild。

Connection

选择 Bitbucket 连接或 Secrets Manager 密钥，通过指定的连接类型进行连接。

存储库

选择我的 Bitbucket 账户中的存储库或公共存储库，然后输入存储库 URL。

源版本

输入分支、提交 ID、标签，或引用以及提交 ID。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

注意

我们建议您选择看起来不像提交 ID 的 Git 分支名称，例如 811dd1ba1aba14473856cee38308caed7190c0d 或 5392f7。这可以帮助您避免 Git 签出与实际提交发生冲突。

Git 克隆深度

选择Git 克隆深度以创建一个浅克隆，其历史记录会截断至指定数量的提交。如果您需要完整克隆，请选择完整。

Git 子模块

如果您希望在存储库中包含 Git 子模块，请选择使用 Git 子模块。

构建状态

如果您希望向源提供商报告构建的开始和完成状态，请选择在您的构建开始和完成时向源提供商报告构建状态。

为了能够向源提供商报告构建状态，与源提供商关联的用户必须拥有对存储库的写入权限。如果用户没有写入权限，则无法更新构建状态。有关更多信息，请参阅源提供商访问权限。

在状态上下文中，输入要在 Bitbucket 提交状态中用于 name 参数的值。有关更多信息，请参阅 Bitbucket API 文档中的构建。

在目标 URL 中，输入要在 Bitbucket 提交状态中用于 url 参数的值。有关更多信息，请参阅 Bitbucket API 文档中的构建。

由 Webhook 触发的构建的状态将始终报告给源提供商。要将从控制台或 API 调用启动的构建状态报告给源提供商，您必须选择此设置。

如果项目的构建通过 webhook 触发，则必须将新的提交推送到存储库，此设置才能生效。

如果您希望每次将代码更改推送到该存储库时 CodeBuild 都构建源代码，请在主要源 Webhook 事件中选择每次将代码更改推送到此存储库时都会重新生成。有关 webhook 和筛选条件组的更多信息，请参阅 Bitbucket Webhook 事件。

GitHub

凭证

选择默认来源凭证或自定义来源凭证，然后按照说明管理默认来源凭证或自定义源凭证。

连接类型

选择 GitHub 应用程序、OAuth 或个人访问令牌以连接到 CodeBuild。

Connection

选择 GitHub 连接或 Secrets Manager 密钥，通过指定的连接类型进行连接。

存储库

选择我的 GitHub 账户中的存储库、公共存储库或 GitHub 范围内的 webhook，然后输入存储库 URL。

源版本

输入分支、提交 ID、标签，或引用以及提交 ID。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

注意

我们建议您选择看起来不像提交 ID 的 Git 分支名称，例如 811dd1ba1aba14473856cee38308caed7190c0d 或 5392f7。这可以帮助您避免 Git 签出与实际提交发生冲突。

Git 克隆深度

选择Git 克隆深度以创建一个浅克隆，其历史记录会截断至指定数量的提交。如果您需要完整克隆，请选择完整。

Git 子模块

如果您希望在存储库中包含 Git 子模块，请选择使用 Git 子模块。

构建状态

如果您希望向源提供商报告构建的开始和完成状态，请选择在您的构建开始和完成时向源提供商报告构建状态。

为了能够向源提供商报告构建状态，与源提供商关联的用户必须拥有对存储库的写入权限。如果用户没有写入权限，则无法更新构建状态。有关更多信息，请参阅 源提供商访问权限。

在状态上下文中，输入要在 GitHub 提交状态中用于 context 参数的值。有关更多信息，请参阅《GitHub 开发人员指南》中的创建提交状态。

在目标 URL 中，输入要在 GitHub 提交状态中用于 target_url 参数的值。有关更多信息，请参阅《GitHub 开发人员指南》中的创建提交状态。

由 Webhook 触发的构建的状态将始终报告给源提供商。要将从控制台或 API 调用启动的构建状态报告给源提供商，您必须选择此设置。

如果项目的构建通过 webhook 触发，则必须将新的提交推送到存储库，此设置才能生效。

如果您希望每次将代码更改推送到该存储库时 CodeBuild 都构建源代码，请在主要源 Webhook 事件中选择每次将代码更改推送到此存储库时都会重新生成。有关 webhook 和筛选条件组的更多信息，请参阅 GitHub Webhook 事件。

GitHub Enterprise Server

凭证

选择默认来源凭证或自定义来源凭证，然后按照说明管理默认来源凭证或自定义源凭证。

连接类型

选择 CodeConnections 或个人访问令牌以连接到 CodeBuild。

Connection

选择 GitHub Enterprise 连接或 Secrets Manager 密钥，通过指定的连接类型进行连接。

存储库

选择我的 GitHub Enterprise 账户中的存储库或 GitHub Enterprise 范围内的 webhook，然后输入存储库 URL。

源版本

输入拉取请求、分支、提交 ID、标签，或引用以及提交 ID。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

注意

我们建议您选择看起来不像提交 ID 的 Git 分支名称，例如 811dd1ba1aba14473856cee38308caed7190c0d 或 5392f7。这可以帮助您避免 Git 签出与实际提交发生冲突。

Git 克隆深度

选择Git 克隆深度以创建一个浅克隆，其历史记录会截断至指定数量的提交。如果您需要完整克隆，请选择完整。

Git 子模块

如果您希望在存储库中包含 Git 子模块，请选择使用 Git 子模块。

构建状态

如果您希望向源提供商报告构建的开始和完成状态，请选择在您的构建开始和完成时向源提供商报告构建状态。

为了能够向源提供商报告构建状态，与源提供商关联的用户必须拥有对存储库的写入权限。如果用户没有写入权限，则无法更新构建状态。有关更多信息，请参阅 源提供商访问权限。

在状态上下文中，输入要在 GitHub 提交状态中用于 context 参数的值。有关更多信息，请参阅《GitHub 开发人员指南》中的创建提交状态。

在目标 URL 中，输入要在 GitHub 提交状态中用于 target_url 参数的值。有关更多信息，请参阅《GitHub 开发人员指南》中的创建提交状态。

由 Webhook 触发的构建的状态将始终报告给源提供商。要将从控制台或 API 调用启动的构建状态报告给源提供商，您必须选择此设置。

如果项目的构建通过 webhook 触发，则必须将新的提交推送到存储库，此设置才能生效。

不安全的 SSL

选择启用不安全的 SSL，在连接到您的 GitHub Enterprise 项目存储库时忽略 SSL 警告。

如果您希望每次将代码更改推送到该存储库时 CodeBuild 都构建源代码，请在主要源 Webhook 事件中选择每次将代码更改推送到此存储库时都会重新生成。有关 webhook 和筛选条件组的更多信息，请参阅 GitHub Webhook 事件。

GitLab

凭证

选择默认来源凭证或自定义来源凭证，然后按照说明管理默认来源凭证或自定义源凭证。

连接类型

CodeConnections 用于将 GitLab 连接到 CodeBuild。

Connection

选择要通过 CodeConnections 进行连接的 GitLab 连接。

存储库

选择要使用的存储库。

源版本

输入拉取请求 ID、分支、提交 ID、标签，或引用以及提交 ID。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

注意

我们建议您选择看起来不像提交 ID 的 Git 分支名称，例如 811dd1ba1aba14473856cee38308caed7190c0d 或 5392f7。这可以帮助您避免 Git 签出与实际提交发生冲突。

Git 克隆深度

选择Git 克隆深度以创建一个浅克隆，其历史记录会截断至指定数量的提交。如果您需要完整克隆，请选择完整。

构建状态

如果您希望向源提供商报告构建的开始和完成状态，请选择在您的构建开始和完成时向源提供商报告构建状态。

为了能够向源提供商报告构建状态，与源提供商关联的用户必须拥有对存储库的写入权限。如果用户没有写入权限，则无法更新构建状态。有关更多信息，请参阅 源提供商访问权限。

GitLab Self Managed

凭证

选择默认来源凭证或自定义来源凭证，然后按照说明管理默认来源凭证或自定义源凭证。

连接类型

CodeConnections 用于将 GitLab 自行管理连接到 CodeBuild。

Connection

选择要通过 CodeConnections 进行连接的 GitLab 自行管理连接。

存储库

选择要使用的存储库。

源版本

输入拉取请求 ID、分支、提交 ID、标签，或引用以及提交 ID。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

注意

我们建议您选择看起来不像提交 ID 的 Git 分支名称，例如 811dd1ba1aba14473856cee38308caed7190c0d 或 5392f7。这可以帮助您避免 Git 签出与实际提交发生冲突。

Git 克隆深度

选择Git 克隆深度以创建一个浅克隆，其历史记录会截断至指定数量的提交。如果您需要完整克隆，请选择完整。

构建状态

如果您希望向源提供商报告构建的开始和完成状态，请选择在您的构建开始和完成时向源提供商报告构建状态。

为了能够向源提供商报告构建状态，与源提供商关联的用户必须拥有对存储库的写入权限。如果用户没有写入权限，则无法更新构建状态。有关更多信息，请参阅 源提供商访问权限。

环境

BuildSpec

批量配置

您可以将一组构建作为单个操作来运行。有关更多信息，请参阅 批量运行构建。

构件

日志

选择要创建的日志。您可以创建 Amazon CloudWatch Logs 或 Amazon S3 日志，也可以两者都创建。

创建构建项目 (Amazon CLI)

有关将 Amazon CLI 与 CodeBuild 结合使用的更多信息，请参阅命令行参考。

要使用 Amazon CLI 创建 CodeBuild 构建项目，您需要创建 JSON 格式的项目结构，填写该结构，然后调用 create-project 命令来创建项目。

创建 JSON 文件

利用 create-project 命令和 --generate-cli-skeleton 选项创建骨架 JSON 文件：

aws codebuild create-project --generate-cli-skeleton > <json-file>

这将创建 JSON 文件，其路径和文件名由 <json-file> 指定。

填写 JSON 文件

按照下面所示修改 JSON 数据，并保存您的结果。

{
  "name": "<project-name>",
  "description": "<description>",
  "source": {
    "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
    "location": "<source-location>",
    "gitCloneDepth": "<git-clone-depth>",
    "buildspec": "<buildspec>",
    "InsecureSsl": "<insecure-ssl>",
    "reportBuildStatus": "<report-build-status>",
    "buildStatusConfig": {
      "context": "<context>",
      "targetUrl": "<target-url>"
    },
    "gitSubmodulesConfig": {
      "fetchSubmodules": "<fetch-submodules>"
    },
    "auth": {
      "type": "<auth-type>",
      "resource": "<auth-resource>"
    },
    "sourceIdentifier": "<source-identifier>"
  },
  "secondarySources": [
    {
        "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
        "location": "<source-location>",
        "gitCloneDepth": "<git-clone-depth>",
        "buildspec": "<buildspec>",
        "InsecureSsl": "<insecure-ssl>",
        "reportBuildStatus": "<report-build-status>",
        "auth": {
          "type": "<auth-type>",
          "resource": "<auth-resource>"
        },
        "sourceIdentifier": "<source-identifier>"
    }
  ],
  "secondarySourceVersions": [
    {
      "sourceIdentifier": "<secondary-source-identifier>",
      "sourceVersion": "<secondary-source-version>"
    }
  ],
  "sourceVersion": "<source-version>",
  "artifacts": {
    "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
    "location": "<artifacts-location>",
    "path": "<artifacts-path>",
    "namespaceType": "<artifacts-namespacetype>",
    "name": "<artifacts-name>",
    "overrideArtifactName": "<override-artifact-name>",
    "packaging": "<artifacts-packaging>"
  },
  "secondaryArtifacts": [
    {
      "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
      "location": "<secondary-artifact-location>",
      "path": "<secondary-artifact-path>",
      "namespaceType": "<secondary-artifact-namespaceType>",
      "name": "<secondary-artifact-name>",
      "packaging": "<secondary-artifact-packaging>",
      "artifactIdentifier": "<secondary-artifact-identifier>"
    }
  ],
  "cache": {
    "type": "<cache-type>",
    "location": "<cache-location>",
    "mode": [
      "<cache-mode>"
    ]
  },
  "environment": {
    "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER" | "WINDOWS_SERVER_2022_CONTAINER",
    "image": "<image>",
    "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE",
    "certificate": "<certificate>",
    "environmentVariables": [
      {
        "name": "<environmentVariable-name>",
        "value": "<environmentVariable-value>",
        "type": "<environmentVariable-type>"
      }
    ],
    "registryCredential": [
      {
        "credential": "<credential-arn-or-name>",
        "credentialProvider": "<credential-provider>"
      }
    ],
    "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE",
    "privilegedMode": "<privileged-mode>"
  },
  "serviceRole": "<service-role>",
  "autoRetryLimit": <auto-retry-limit>,
  "timeoutInMinutes": <timeout>,
  "queuedTimeoutInMinutes": <queued-timeout>,
  "encryptionKey": "<encryption-key>",
  "tags": [
    {
      "key": "<tag-key>",
      "value": "<tag-value>"
    }
  ],
  "vpcConfig": {
    "securityGroupIds": [
         "<security-group-id>"
    ],
    "subnets": [
         "<subnet-id>"
    ],
    "vpcId": "<vpc-id>"
  },
  "badgeEnabled": "<badge-enabled>",
  "logsConfig": {
    "cloudWatchLogs": {
      "status": "<cloudwatch-logs-status>",
      "groupName": "<group-name>",
      "streamName": "<stream-name>"
    },
    "s3Logs": {
      "status": "<s3-logs-status>",
      "location": "<s3-logs-location>",
      "encryptionDisabled": "<s3-logs-encryption-disabled>"
    }
  },
  "fileSystemLocations": [
    {
      "type": "EFS",
      "location": "<EFS-DNS-name-1>:/<directory-path>",
      "mountPoint": "<mount-point>",
      "identifier": "<efs-identifier>",
      "mountOptions": "<efs-mount-options>"
    }
  ],
  "buildBatchConfig": {
    "serviceRole": "<batch-service-role>",
    "combineArtifacts": <combine-artifacts>,
    "restrictions": {
      "maximumBuildsAllowed": <max-builds>,
      "computeTypesAllowed": [
        "<compute-type>"
      ]
    },
    "timeoutInMins": <batch-timeout>,
    "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS"
  },
  "concurrentBuildLimit": <concurrent-build-limit>
}

替换以下内容：

name

必需。此构建项目的名称。此名称在您的 Amazon 账户的所有构建项目中必须是唯一的。

描述

可选。此构建项目的描述。

源

必需。ProjectSource 对象，其中包含有关此构建项目的源代码设置的信息。添加 source 对象后，可以使用 secondarySources 额外添加多达 12 个源。这些设置包括：

secondarySources

可选。一组 ProjectSource 对象，其中包含有关构建项目辅助源的信息。最多可以添加 12 个辅助源。这些 secondarySources 对象使用的属性与源对象使用的属性相同。在辅助源对象中，sourceIdentifier 是必需项。

secondarySourceVersions

可选。一组 ProjectSourceVersion 对象。如果在构建级别指定 secondarySourceVersions，则它们优先于此对象。

sourceVersion

可选。要为此项目构建的构建输入的版本。如果未指定，则使用最新版本。如果已指定，则它必须是下列项之一：

如果在构建级别指定 sourceVersion，则该版本将优先于此 sourceVersion（在项目级别）。有关更多信息，请参阅 使用 Amazon CodeBuild 的源版本示例。

构件

必需。ProjectArtifacts 对象，其中包含有关此构建项目的输出构件设置的信息。添加 artifacts 对象后，可以使用 secondaryArtifacts 额外添加最多 12 个构件。这些设置包括：

secondaryArtifacts

可选。一组 ProjectArtifacts 对象，其中包含有关构建项目辅助构件设置的信息。最多可以添加 12 个辅助构件。secondaryArtifacts 使用的许多设置与 构件 对象相同。

cache

必需。ProjectCache 对象，其中包含有关此构建项目的缓存设置的信息。有关更多信息，请参阅缓存构建。

environment

必需。ProjectEnvironment 对象，其中包含有关此项目的构建环境设置的信息。这些设置包括：

serviceRole

必需。CodeBuild 代表用户用来与服务进行交互的服务角色 ARN（例如，arn:aws:iam::account-id:role/role-name）。

autoRetryLimit

可选。构建失败后额外的自动重试次数。例如，如果自动重试限制设置为 2，则 CodeBuild 将调用 RetryBuild API 来自动重试您的构建，最多再重试 2 次。

timeoutInMinutes

可选。5 到 2160 分钟（36 个小时）之间的一个分钟数，在此时间后，如果构建未完成，CodeBuild 会将其停止。如果未指定，则使用默认值 60。要确定 CodeBuild 是否以及何时因超时而停止生成，请运行 batch-get-builds 命令。要确定构建是否已停止，请在输出中查看 buildStatus 的值是否为 FAILED。要确定构建何时超时，请在输出中查看与 TIMED_OUT 的 phaseStatus 值关联的 endTime 值。

queuedTimeoutInMinutes

可选。5 到 480 分钟 (8 个小时) 之间的一个分钟数，在此时间后，如果构建仍在排队状态，CodeBuild 会将其停止。如果未指定，则使用默认值 60。

encryptionKey

可选。CodeBuild 用于加密构建输出的 Amazon KMS key 的别名或 ARN。如果您指定别名，请使用格式 arn:aws:kms:region-ID:account-ID:key/key-ID，或者，如果存在别名，请使用格式 alias/key-alias。如果未指定，则会使用 Amazon S3 的 Amazon 托管 KMS 密钥。

tags

可选。一组 Tag 对象，提供您要与此构建项目关联的标签。您最多可指定 50 个标签。这些标签可由支持 CodeBuild 构建项目标签的任何 Amazon 服务使用。每个标签都表示为带有 key 和 value 的对象。

vpcConfig

可选。VpcConfig 对象，其中包含有关您的项目 VPC 配置的信息。有关更多信息，请参阅将 Amazon CodeBuild 与 Amazon Virtual Private Cloud 结合使用。

这些属性包括：

badgeEnabled

可选。指定是否在 CodeBuild 项目中包含构建徽章。设置为 true 可启用构建徽章；设置为 false 可将其禁用。有关更多信息，请参阅 使用 CodeBuild 构建徽章示例。

logsConfig

LogsConfig 对象，其中包含有关此构建日志所在位置的信息。

fileSystemLocations

可选。一组 ProjectFileSystemsLocation 对象，其中包含有关 Amazon EFS 配置的信息。

buildBatchConfig

可选。buildBatchConfig 对象采用 ProjectBuildBatchConfig 结构，其中包含项目的批量构建配置信息。

concurrentBuildLimit

此项目允许的并发构建的最大数量。

仅当当前构建数量小于或等于此限值时，才会启动新构建。如果当前构建计数达到此限值，则新构建将受到限制且不会运行。

创建项目

要创建项目，请再次运行 create-project 命令，传递您的 JSON 文件：

aws codebuild create-project --cli-input-json file://<json-file>

如果成功，项目对象的 JSON 表示形式将显示在控制台输出中。有关此数据的示例，请参阅 CreateProject 响应语法。

您稍后可以更改构建项目的任何设置，但构建项目名称除外。有关更多信息，请参阅更改构建项目的设置 (Amazon CLI)。

要开始运行构建，请参阅运行构建 (Amazon CLI)。

如果您的源代码存储在 GitHub 存储库中，并且您希望 CodeBuild 在每次代码更改被推送到存储库时重建源代码，请参阅开始自动运行构建（Amazon CLI）。

创建构建项目（Amazon 开发工具包）

有关将 Amazon CodeBuild 与 Amazon 开发工具包结合使用的信息，请参阅 Amazon 开发工具包和工具参考。

创建构建项目 (Amazon CloudFormation)

有关将 Amazon CodeBuild 与 Amazon CloudFormation 结合使用的信息，请参阅《Amazon CloudFormation 用户指南》中的 CodeBuild 的 Amazon CloudFormation 模板。