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

在 CodeBuild 中将访问令牌与您的源提供商结合使用

本示例说明了如何使用访问令牌连接到 GitHub 或 Bitbucket。对于 GitHub 或 GitHub Enterprise,使用个人访问令牌。对于 Bitbucket,使用应用程序密码。

访问令牌先决条件

在开始之前,您必须向访问令牌添加适当的权限范围。

对于 GitHub,您的个人访问令牌必须具有以下权限范围。

  • repo:授予私有存储库的完全控制权。

  • repo:status:授予提交状态的访问权限。

  • admin:repo_hook:授予存储库挂钩的完全控制权。如果您的令牌具有 repo 范围,则不需要此权限范围。

有关更多信息,请参阅了解 OAuth 应用程序的范围

对于 Bitbucket,您的应用程序密码必须具有以下权限范围。

  • repository:read:授予对授权用户有权访问的所有存储库的读取访问权限。

  • pullrequest:read:授予对拉取请求的读取访问权限。如果您的项目具有 Bitbucket Webhook,则您的应用程序密码必须具有此权限范围。

  • Webhook:授予对 Webhook 的访问权限。如果您的项目具有 Webhook 操作,则您的应用程序密码必须具有此权限范围。

有关更多信息,请参阅 Bitbucket 云 REST API 的权限范围Bitbucket 云上的 OAuth

使用访问令牌连接源提供商(控制台)

要在控制台中使用访问令牌将您的项目连接到 GitHub 或 Bitbucket,请在创建项目时执行以下操作。有关信息,请参阅创建构建项目 (控制台)

对于 GitHub:

  1. 对于 Source provider (源提供商),选择 GitHub

  2. 对于 Repository (存储库),选择 Connect with a GitHub personal access token (使用 GitHub 个人访问令牌进行连接)

  3. GitHub personal access token (GitHub 个人访问令牌) 中,输入您的 GitHub 个人访问令牌。

  4. 选择 Save token (保存令牌)

对于 Bitbucket:

  1. 对于 Source provider (源提供商),选择 Bitbucket

    注意

    CodeBuild 不支持 Bitbucket 服务器。

  2. 对于 Repository (存储库),选择 Connect with a Bitbucket app password (使用 Bitbucket 应用程序密码进行连接)

  3. Bitbucket username (Bitbucket 用户名) 中,输入您的 Bitbucket 用户名。

  4. Bitbucket app password (Bitbucket 应用程序密码) 中,输入您的 Bitbucket 应用程序密码。

  5. 选择 Save Bitbucket credentials (保存 Bitbucket 凭证)

使用访问令牌连接源提供商 (CLI)

按照以下步骤在 AWS CLI 中使用访问令牌将您的项目连接到 GitHub 或 Bitbucket。有关将 AWS CLI 与 AWS CodeBuild 结合使用的信息,请参阅命令行参考

  1. 运行 import-source-credentials 命令:

    aws codebuild import-source-credentials --generate-cli-skeleton

    输出中将显示 JSON 格式的数据。将数据复制到本地计算机上或安装 AWS CLI 的实例上某位置处的文件(如 import-source-credentials.json)中。按照下面所示修改复制的数据,并保存您的结果。

    { "serverType": "server-type", "authType": "auth-type", "shouldOverwrite": "should-overwrite", "token": "token", "username": "username" }

    替换以下内容:

    • server-type:必填值。用于此凭证的源提供商。有效值为 GITHUB、GITHUB_ENTERPRISE 和 BITBUCKET。

    • auth-type:必填值。用于连接到 GitHub、GitHub Enterprise 或 Bitbucket 存储库的身份验证类型。有效值包括 PERSONAL_ACCESS_TOKEN 和 BASIC_AUTH。您不能使用 CodeBuild API 来创建 OAUTH 连接。您必须改为使用 CodeBuild 控制台。

    • should-overwrite:可选值。设置为 false 可防止覆盖存储库源凭证。设置为 true 可覆盖存储库源凭证。默认值为 true

    • token:必填值。对于 GitHub 或 GitHub Enterprise,这是个人访问令牌。对于 Bitbucket,这是应用程序密码。

    • username:可选值。当 authType 为 BASIC_AUTH 的 Bitbucket 用户名。对于其他类型的源提供商或连接,将忽略此参数。

  2. 要使用访问令牌连接您的账户,请切换到包含您在步骤 1 中保存的 import-source-credentials.json 文件的目录,然后重新运行 import-source-credentials 命令。

    aws codebuild import-source-credentials --cli-input-json file://import-source-credentials.json

    JSON 格式的数据将使用 Amazon 资源名称 (ARN) 显示在输出中。

    { "arn": "arn:aws:codebuild:region:account-id:token/server-type" }

    注意

    如果您再次使用相同的服务器类型和身份验证类型运行 import-source-credentials 命令,则会更新存储的访问令牌。

    在使用访问令牌连接您的账户后,您可以使用 create-project 来创建您的 CodeBuild 项目。有关更多信息,请参阅创建构建项目 (AWS CLI)

  3. 要查看连接的访问令牌,请运行 list-source-credentials 命令。

    aws codebuild list-source-credentials

    JSON 格式的 sourceCredentialsInfos 对象将显示在输出中:

    { "sourceCredentialsInfos": [ { "authType": "auth-type", "serverType": "server-type", "arn": "arn" } ] }

    sourceCredentialsObject 包含连接的源凭证信息的列表:

    • authType 是凭证使用的身份验证类型。这可以是 OAUTHBASIC_AUTHPERSONAL_ACCESS_TOKEN

    • serverType 是源提供商类型。这可以是 GITHUBGITHUB_ENTERPRISEBITBUCKET

    • arn 是令牌的 ARN。

  4. 要断开与源提供商的连接并删除其访问令牌,请使用其 ARN 运行 delete-source-credentials 命令。

    aws codebuild delete-source-credentials --arn arn-of-your-credentials

    将返回 JSON 格式的数据,并带有已删除证书的 ARN。

    { "arn": "arn:aws:codebuild:region:account-id:token/server-type" }