View a markdown version of this page

連接 GitHub - AWS DevOps 代理程式
先決條件註冊 GitHub （帳戶層級）將儲存庫連線至 代理程式空間了解 GitHub 應用程式GitHub 應用程式許可更新管理 GitHub 連線

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

連接 GitHub

GitHub 整合可讓 AWS DevOps 代理程式在事件調查期間存取程式碼儲存庫並接收部署事件。此整合遵循兩個步驟：GitHub 的帳戶層級註冊，接著將特定儲存庫連線至個別的 Agent Spaces。

AWS DevOps Agent 同時支援 GitHub.com (SaaS) 和 GitHub Enterprise Server （自我託管） 執行個體。

先決條件

連接 GitHub 之前，請確定您已：

  • 存取 AWS DevOps 代理程式管理員主控台

  • 具有管理員許可的 GitHub 使用者帳戶或組織

  • 在您的帳戶或組織中安裝 GitHub 應用程式的授權

對於 GitHub Enterprise Server，您也需要：

  • 透過 HTTPS 存取的 GitHub Enterprise Server 執行個體 (3.x 版或更新版本）

  • GitHub Enterprise Server 執行個體的 HTTPS URL （例如 https://github.example.com)

  • （選用） 私有連線，如果您的 GitHub Enterprise Server 執行個體無法公開存取

註冊 GitHub （帳戶層級）

GitHub 已在 AWS 帳戶層級註冊，並在該帳戶中的所有客服人員空間之間共用。每個 AWS 帳戶只需要註冊一次 GitHub。

步驟 1：導覽至管道供應商

  1. 登入 AWS 管理主控台

  2. 導覽至 AWS DevOps 代理程式主控台

  3. 前往功能索引標籤

  4. 在管道區段中，按一下新增

  5. 從可用提供者清單中選取 GitHub

如果 GitHub 尚未註冊，系統會提示您先註冊。

步驟 2：選擇連線類型

在「註冊 GitHub 帳戶/組織」畫面上，選取您是以使用者或組織身分連線：

  • 使用者 – 具有使用者名稱和設定檔的個人 GitHub 帳戶

  • 組織 – 共用的 GitHub 帳戶，其中多個人員可以一次跨多個專案進行協作

如果您要連線至 GitHub Enterprise Server 執行個體，請勾選使用 GitHub Enterprise Server 核取方塊，然後輸入執行個體的 HTTPS URL （例如 https://github.example.com)。

如果您的 GitHub Enterprise Server 執行個體無法公開存取，您可以選擇設定私有連線，以允許 AWS DevOps 代理程式安全地連線到您的執行個體。如需詳細資訊，請參閱連線至私有託管工具。

注意

請勿在 URL 中包含 /api/v3或任何結尾路徑 - 請僅輸入基本 URL。

步驟 3：設定 GitHub 應用程式

按一下提交以開始應用程式設定程序。後續步驟會根據您是否連線到 GitHub.com 或 GitHub Enterprise Server 而有所不同。

對於 GitHub.com

  1. 您將重新導向至 GitHub 以安裝 AWS DevOps Agent GitHub 應用程式。

  2. 選取要安裝應用程式的 帳戶或組織。

  3. 應用程式允許 AWS DevOps 代理程式從連線的儲存庫接收事件，包括部署事件。

對於 GitHub Enterprise Server

GitHub Enterprise Server 使用 GitHub 應用程式資訊清單流程，自動在您的執行個體上設定新的 GitHub 應用程式。這包括 GitHub Enterprise Server 執行個體的兩個重新導向。

  1. 您的瀏覽器將重新導向至 GitHub Enterprise Server 執行個體的「建立 GitHub 應用程式」頁面。

  2. 您將看到應用程式名稱已預先填入。您可以視需要變更名稱。按一下建立 GitHub 應用程式。

  3. 系統會將您重新導向回 AWS DevOps 代理程式，該代理程式會交換資訊清單程式碼以取得應用程式登入資料。

步驟 4：選取儲存庫並完成安裝

  1. 您將看到 GitHub 應用程式的安裝與授權頁面。

  2. 選取要允許應用程式存取的儲存庫：

    • 所有儲存庫 – 授予所有目前和未來儲存庫的存取權

    • 僅選取儲存庫 – 從您的帳戶或組織選擇特定儲存庫

  3. 按一下安裝與授權。

  4. 系統會將您重新導向回 AWS DevOps 代理程式主控台，其中 GitHub 會在帳戶層級顯示為已註冊。

將儲存庫連線至 代理程式空間

在帳戶層級註冊 GitHub 之後，您可以將特定儲存庫連線至個別客服人員空間：

  1. 在 AWS DevOps 代理程式主控台中，選取您的代理程式空間

  2. 前往功能索引標籤

  3. 在管道區段中，按一下新增

  4. 從可用提供者清單中選取 GitHub

  5. 選取與此客服人員空間相關的儲存庫子集

  6. 按一下新增以完成連線

您可以根據您的組織需求，將不同的儲存庫集連接到不同的 Agent Spaces。

了解 GitHub 應用程式

AWS DevOps Agent GitHub 應用程式：

  • 請求存取您的儲存庫 - 您可以在 GitHub 應用程式安裝期間檢閱特定許可

  • 接收部署事件和其他儲存庫事件

  • 允許 AWS DevOps 代理程式將程式碼變更與操作事件建立關聯

  • 您可以隨時透過 GitHub 設定解除安裝

對於 GitHub Enterprise Server，GitHub 應用程式會在註冊期間自動在您的執行個體上建立。您可以透過設定 > 應用程式 > 已安裝的 GitHub 應用程式來管理應用程式的儲存庫存取權或將其解除安裝。若要完全刪除應用程式定義，請前往設定 > 開發人員設定 > GitHub 應用程式。

GitHub 應用程式許可更新

在您安裝 GitHub 應用程式以支援新功能後，AWS DevOps 代理程式可能會請求許可更新。發生這種情況時：

  1. 您將從 GitHub 收到有關許可更新請求的通知。

  2. 檢閱更新詳細資訊，以了解正在請求的新許可。

  3. 接受請求以授予更新的許可。

您的服務或應用程式不需要變更。一旦您接受更新後的許可，來自 GitHub 的下一個安裝存取權杖 AWS DevOps 代理程式請求將自動包含新的許可。

注意

在您接受許可更新之前， AWS DevOps 代理程式會繼續以先前授予的許可操作。在您核准請求之前，將無法使用依賴更新許可的新功能。

管理 GitHub 連線

  • 更新儲存庫存取 – 若要變更 GitHub 應用程式可存取的儲存庫，請前往您的 GitHub 帳戶或組織設定 （或 GitHub Enterprise Server 執行個體設定）、導覽至已安裝的 GitHub 應用程式，以及修改 AWS DevOps Agent 應用程式組態。

  • 檢視連線的儲存庫 – 在 AWS DevOps 代理程式主控台中，選取您的代理程式空間，然後前往功能索引標籤，在管道區段中檢視連線的儲存庫。

  • 移除 GitHub 連線 – 若要中斷 GitHub 與客服人員空間的連線，請在管道區段中選取連線，然後按一下移除。若要完全解除安裝 GitHub 應用程式，請從 GitHub 帳戶或組織設定解除安裝它。對於 GitHub Enterprise Server，由於 GitHub 應用程式是在註冊期間直接在您的執行個體上建立，因此您可以選擇完全清除應用程式，方法是執行下列兩項操作：

    • 解除安裝應用程式 – 前往設定 > 應用程式 > 安裝的 GitHub 應用程式，按一下應用程式上的設定，然後解除安裝應用程式。

    • 刪除應用程式 – 前往設定 > 開發人員設定 > GitHub 應用程式、選取應用程式、前往進階索引標籤，然後選擇刪除 GitHub 應用程式。警告：刪除 GitHub 應用程式是永久性的，無法復原。如果您刪除它，您將需要從 AWS DevOps 代理程式主控台的開頭重新註冊 GitHub Enterprise Server，以建立新的應用程式。