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

# GitHub 连接
<a name="connections-github"></a>

您可以使用连接来授权和建立将您的第三方提供商与您的 AWS 资源关联的配置。

**注意**  
不用再创建连接或使用账户中的现有链接，您可以使用其他 AWS 账户之间的共享连接。请参阅[使用与其他账户共享的连接](connections-shared.md)。

**注意**  
此功能不适用于亚太地区（香港）、亚太地区（海得拉巴）、亚太地区（雅加达）、亚太地区（墨尔本）、亚太地区（墨尔本）、亚太地区（大阪）、非洲（开普敦）、中东（巴林）、中东（阿联酋）、欧洲（西班牙）、欧洲（苏黎世）、以色列（特拉维夫） AWS GovCloud 或（美国西部）地区。要参考其他可用操作，请参阅 [产品和服务与 CodePipeline](integrations.md)。有关在欧洲地区（米兰）区域使用此操作的注意事项，请参阅[CodeStarSourceConnection 适用于 Bitbucket Cloud GitHub、、 GitHub 企业服务器、 GitLab .com 和 GitLab 自我管理操作](action-reference-CodestarConnectionSource.md)中的说明。

要在中为您的企业云存储库 GitHub 或 GitHub 企业云存储库添加源操作 CodePipeline，您可以选择：
+ 使用 CodePipeline 控制台的 “**创建管道**” 向导或 **“编辑” 操作**页面选择 **GitHub （通过 GitHub应用程序）**提供者选项。参阅[创建与 GitHub 企业服务器（控制台）的连接](connections-ghes.md#connections-ghes-console)以添加操作。控制台可帮助您创建连接资源。
**注意**  
有关指导您如何添加 GitHub 连接以及如何使用管道中的 “**完全克隆” 选项克隆**元数据的教程，请参阅[教程：使用带有 GitHub 管道源的完整克隆](tutorials-github-gitclone.md)。
+ 使用 CLI，通过[创建管道（CLI）](pipelines-create.md#pipelines-create-cli) 中所示的步骤，添加提供方为 `GitHub` 的 `CodeStarSourceConnection` 操作的操作配置。

**注意**  
您也可以使用开发人员工具控制台，在**设置**下创建连接。参阅[创建连接](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create.html)。

开始前的准备工作：
+ 您必须已使用创建账户 GitHub。
+ 您必须已经创建了 GitHub 代码存储库。
+ 如果您的 CodePipeline 服务角色是在 2019 年 12 月 18 日之前创建的，则可能需要更新其权限才能`codestar-connections:UseConnection`用于 AWS CodeStar 连接。有关说明，请参阅[为 CodePipeline 服务角色添加权限](how-to-custom-role.md#how-to-update-role-new-services)。

**注意**  
要创建连接，您必须是 GitHub 组织所有者。对于不属于组织的存储库，您必须是存储库拥有者。

**Topics**
+ [创建与 GitHub （控制台）的连接](#connections-github-console)
+ [创建与 GitHub (CLI) 的连接](#connections-github-cli)

## 创建与 GitHub （控制台）的连接
<a name="connections-github-console"></a>

使用这些步骤使用 CodePipeline 控制台为您的 GitHub或 GitHub 企业云存储库添加连接操作。

**注意**  
在这些步骤中，您可以在**存储库访问**下选择特定的存储库。任何未被选中的存储库都将无法访问或看见 CodePipeline。

### 步骤 1：创建或编辑您的管道
<a name="connections-github-console-action"></a>

1. 登录 CodePipeline 控制台。

1. 选择下列选项之一。
   + 选择创建管道。按照*创建管道* 中的步骤操作，完成第一个屏幕，然后选择**下一步**。在 “**来源**” 页面的 “**源提供者**” 下，选择 **GitHub （通过 GitHub 应用程序）**。
   + 选择编辑现有管道。选择**编辑**，然后选择**编辑阶段**。选择添加或编辑您的源操作。在**编辑操作**页面的**操作名称**下，输入您的操作的名称。在**操作提供者**中，选择 **GitHub （通过 GitHub应用程序）**。

1. 请执行以下操作之一：
   + 在 “**连接**” 下，如果您尚未创建与提供商的连接，请选择 **Connection to GitHub**。继续执行步骤 2：创建与的连接 GitHub。
   + 在**连接**下，如果您已创建到提供程序的连接，请选择该连接。继续执行步骤 3：保存连接的源操作。

### 步骤 2：创建与的连接 GitHub
<a name="connections-github-console-create"></a>

选择创建连接后，将出现 “**Connect t GitHub** o” 页面。

![\[显示初始 GitHub 连接页面的控制台屏幕截图。\]](http://docs.aws.amazon.com/zh_cn/codepipeline/latest/userguide/images/github-conn.png)


**要创建与的连接 GitHub**

1. 在 **“GitHub 连接设置”** 下，您的连接名称显示在 “**连接名称**” 中。选择 “**连接到” GitHub**。此时将显示访问请求页面。

1. 选择 “**为 AWS 连接器授权” GitHub**。连接页面将显示并显示 “**GitHub 应用程序**” 字段。  
![\[控制台屏幕截图显示了带有 “ GitHub 应用程序” 字段的初始 GitHub 连接页面。\]](http://docs.aws.amazon.com/zh_cn/codepipeline/latest/userguide/images/github-conn-access-app.png)

1. 在 “**GitHub 应用程序**” 下，选择应用程序安装或选择 “**安装新应用程序**” 来创建一个。

   您可以为与特定提供程序的所有连接安装一个应用程序。如果您已经安装了 GitHub 应用程序 AWS 连接器，请选择它并跳过此步骤。
**注意**  
如果要创建[用户访问令牌](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app)，请确保已经为 GitHub 应用程序安装了 Conn AWS ector，然后将 “应用程序安装” 字段留空。 CodeConnections 将使用用户访问令牌进行连接。

1. 在 “**安装 AWS 连接器 GitHub**” 页面上，选择要在其中安装应用程序的帐户。
**注意**  
您只需为每个 GitHub 账户安装一次该应用程序。如果您之前已安装了应用程序，则可以选择**配置**，继续进入应用程序安装的修改页面，也可以使用后退按钮返回到控制台。

1. 在 “**安装 AWS 连接器 GitHub**” 页面上，保留默认值，然后选择 “**安装**”。

1. 在 “**Connect t** o GitHub” 页面上，新安装的连接 ID 显示在 “**GitHub 应用程序**” 中。选择**连接**。

### 第 3 步：保存您的 GitHub 源代码操作
<a name="connections-github-console-save"></a>

使用**编辑操作**页面上的这些步骤，将源操作与连接信息一起保存。

**保存您的 GitHub 源代码操作**

1. 在**存储库名称**中，选择第三方存储库的名称。

1. 如果您的操作是操作，则可以在 Pip **elin** e 触发器下添加触发器。 CodeConnections 要配置管道触发器配置并选择性使用触发器进行筛选，请参阅[添加带有代码推送或拉取请求事件类型的触发器](pipelines-filter.md)中的更多详细信息。

1. 在**输出构件格式**中，您必须为构件选择格式。
   + 要使用默认方法存储 GitHub 操作的输出对象，请选择**CodePipeline 默认**。该操作访问存储库中的文件，并将工件 GitHub 存储在管道工件存储区的 ZIP 文件中。
   + 要存储包含存储库的 URL 引用的 JSON 文件，以便下游操作可以直接执行 Git 命令，请选择**完全克隆**。此选项只能由 CodeBuild 下游操作使用。

     如果选择此选项，则需要更新 CodeBuild 项目服务角色的权限，如所示[添加连接 Bitbucket、 GitHub、En GitHub terprise Server 或 GitLab .com 的 CodeBuild GitClone 权限](troubleshooting.md#codebuild-role-connections)。如需查看教程以了解如何使用**完整克隆**选项，请参阅[教程：使用带有 GitHub 管道源的完整克隆](tutorials-github-gitclone.md)。

1. 在向导上选择**下一步**，或者在**编辑操作**页面上选择**保存**。

## 创建与 GitHub (CLI) 的连接
<a name="connections-github-cli"></a>

您可以使用 AWS Command Line Interface (AWS CLI) 来创建连接。

为此，请使用 **create-connection** 命令。

**重要**  
默认情况下，通过 AWS CLI 或创建的连接 AWS CloudFormation 处于`PENDING`状态。使用 CLI 或创建连接后 CloudFormation，使用控制台编辑连接以使其处于状态`AVAILABLE`。

**创建连接**

1. 打开终端（Linux、macOS 或 Unix）或命令提示符（Windows）。 AWS CLI 使用运行**create-connection**命令，`--connection-name`为您的连接指定`--provider-type`和。在此示例中，第三方提供方名称为 `GitHub`，指定的连接名称为 `MyConnection`。

   ```
   aws codestar-connections create-connection --provider-type GitHub --connection-name MyConnection
   ```

   如果成功，该命令将返回类似以下内容的连接 ARN 信息。

   ```
   {
       "ConnectionArn": "arn:aws:codestar-connections:us-west-2:account_id:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
   }
   ```

1. 使用控制台完成连接。有关更多信息，请参阅[更新挂起的连接](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-update.html)。

1. 管道默认会在向连接源存储库推送代码时检测更改。要配置手动发布或 Git 标签管道触发器配置，请执行以下操作之一：
   + 要将管道触发器配置为仅通过手动发布启动，请在配置中添加以下行：

     ```
     "DetectChanges": "false",
     ```
   + 要配置管道触发器配置以使用触发器进行筛选，请参阅[添加带有代码推送或拉取请求事件类型的触发器](pipelines-filter.md)中的更多详细信息。例如，以下内容添加到管道 JSON 定义的管道级别。在此示例中，`release-v0` 和 `release-v1` 是要包含的 Git 标签，`release-v2` 是要排除的 Git 标签。

     ```
     "triggers": [
                 {
                     "providerType": "CodeStarSourceConnection",
                     "gitConfiguration": {
                         "sourceActionName": "Source",
                         "push": [
                             {
                                 "tags": {
                                     "includes": [
                                         "release-v0", "release-v1"
                                     ],
                                     "excludes": [
                                         "release-v2"
                                     ]
                                 }
                             }
                         ]
                     }
                 }
             ]
     ```