本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
GitHub 連線
您可以使用連線來授權和建立將第三方供應商與 AWS 資源建立關聯的組態。
注意
此功能不適用於亞太區域 (香港)、亞太區域 (海德拉巴)、亞太區域 (雅加達)、亞太區域 (墨爾本)、亞太區域 (大阪)、非洲 (開普敦)、中東 (巴林)、中東 (UAE)、歐洲 (西班牙)、歐洲 (蘇黎世)、以色列 (特拉維夫) 或 AWS GovCloud (美國西部) 區域。若要參考其他可用的動作,請參閱 與 的產品和服務整合 CodePipeline。如需歐洲 (米蘭) 區域中此動作的考量事項,請參閱中的備註CodeStarSourceConnection 適用於 Bitbucket Cloud GitHub、 GitHub Enterprise Server、 GitLab.com 和 GitLab 自我管理動作。
若要在 中為 GitHub 或 GitHub Enterprise Cloud 儲存庫新增來源動作 CodePipeline,您可以選擇:
-
使用 CodePipeline 主控台建立管道精靈或編輯動作頁面,選擇 GitHub (第 2 版) 供應商選項。請參閱 建立與 GitHub Enterprise Server 的連線 (主控台) 以新增動作。主控台可協助您建立連線資源。
注意
如需教學課程,說明如何新增 GitHub 連線,並使用管道中的完整複製選項來複製中繼資料,請參閱 教學課程:搭配 GitHub 管道來源使用完整複製。
-
使用 CLI,透過 中顯示CLI的步驟,向
GitHub
提供者新增CodeStarSourceConnection
動作的動作組態建立管道 (CLI)。
注意
您也可以使用設定 下的開發人員工具主控台建立連線。請參閱建立連線。
開始之前:
-
您必須已使用 建立 帳戶 GitHub。
-
您必須已建立 GitHub 程式碼儲存庫。
-
如果您的 CodePipeline 服務角色是在 2019 年 12 月 18 日之前建立的,您可能需要更新其用於 AWS CodeStar 連線
codestar-connections:UseConnection
的許可。如需說明,請參閱 將許可新增至 CodePipeline 服務角色。
注意
若要建立連線,您必須是 GitHub 組織擁有者。對於不在組織下的儲存庫,您必須是儲存庫擁有者。
建立 GitHub(主控台) 的連線
使用這些步驟來使用 CodePipeline 主控台為您的 或 GitHub Enterprise Cloud GitHub儲存庫新增連線動作。
注意
在這些步驟中,您可以在儲存庫存取 下選取特定儲存庫。未選取的任何儲存庫將無法存取或由 看見 CodePipeline。
步驟 1:建立或編輯管道
-
登入 CodePipeline 主控台。
-
選擇下列其中一項。
-
選擇建立管道。依照建立管道中的步驟完成第一個畫面,然後選擇下一步。在來源頁面的來源提供者 下,選擇 GitHub (第 2 版)。
-
選擇編輯現有的管道。選擇編輯 ,然後選擇編輯階段 。選擇新增或編輯來源動作。在編輯動作頁面的動作名稱 下,輸入動作的名稱。在動作提供者 中,選擇 GitHub (第 2 版)。
-
-
執行以下任意一項:
-
在連線 下,如果您尚未建立與提供者的連線,請選擇連線至 GitHub。繼續進行步驟 2:建立與 的連線 GitHub。
-
在連線 下,如果您已建立與提供者的連線,請選擇連線。繼續步驟 3:儲存連線的來源動作。
-
步驟 2:建立 的連線 GitHub
選擇建立連線後,便會出現連線至 GitHub頁面。
若要建立 的連線 GitHub
-
在GitHub 連線設定 下,您的連線名稱會顯示在連線名稱 中。選擇連線至 GitHub。隨即會顯示存取請求頁面。
-
選擇 授權 AWS 連接器 GitHub。連線頁面會顯示 ,並顯示GitHub 應用程式欄位。
-
在GitHub 應用程式 下,選擇應用程式安裝,或選擇安裝新應用程式以建立應用程式。
您可以為您連至特定供應商的所有連線安裝一個應用程式。如果您已安裝 GitHub 應用程式的 AWS Connector,請選擇它並略過此步驟。
注意
如果您想要建立使用者存取權杖
,請確定您已經安裝 GitHub 了應用程式的 AWS Connector,然後讓應用程式安裝欄位保持空白。 CodeConnections 將使用使用者存取權杖進行連線。 -
在安裝 AWS 連接器的 GitHub頁面上,選擇要安裝應用程式的帳戶。
注意
每個 GitHub 帳戶只安裝應用程式一次。如果您先前已安裝應用程式,可以選擇 Configure (設定),繼續前往應用程式安裝的修改頁面,或者您可以使用上一步按鈕返回主控台。
-
在安裝 AWS 連接器的 GitHub頁面上,保留預設值,然後選擇安裝 。
-
在連線至 GitHub頁面上,新安裝的連線 ID GitHub 會顯示在應用程式 中。選擇連線。
步驟 3:儲存 GitHub 來源動作
使用編輯動作頁面上的下列步驟,將來源動作與連線資訊一起儲存。
若要儲存 GitHub 來源動作
-
在 Repository name (儲存庫名稱) 中,選擇第三方儲存庫的名稱。
-
如果您的動作是 CodeConnections 動作,您可以在管道觸發條件下新增觸發條件。若要設定管道觸發條件組態,以及選擇性地使用觸發條件進行篩選,請參閱 中的更多詳細資訊程式碼推送或提取請求時篩選觸發條件。
-
在 Output artifact format (輸出成品格式) 中,您必須選擇成品的格式。
-
若要使用預設方法儲存 GitHub 動作的輸出成品,請選擇CodePipeline 預設 。動作會從 GitHub 儲存庫存取檔案,並將成品存放在管道成品存放區中的ZIP檔案中。
-
若要儲存包含儲存庫URL參考JSON的檔案,以便下游動作可以直接執行 Git 命令,請選擇完整複製 。此選項只能由 CodeBuild 下游動作使用。
如果您選擇此選項,您將需要更新 CodeBuild 專案服務角色的許可,如 所示新增 Bitbucket、 GitHub GitHub Enterprise Server 或 GitLab.com 連線的 CodeBuild GitClone 許可。如需示範如何使用完整複製選項的教學課程,請參閱 教學課程:搭配 GitHub 管道來源使用完整複製。
-
-
在精靈上選擇下一步,或在編輯動作頁面上選擇儲存。
建立與 GitHub (CLI) 的連線
您可以使用 AWS Command Line Interface (AWS CLI) 建立連線。
若要這麼做,請使用 create-connection 命令。
重要
根據預設,透過 AWS CLI 或 建立的連線 AWS CloudFormation 處於 PENDING
狀態。建立與 CLI或 的連線後 AWS CloudFormation,請使用 主控台編輯連線,使其成為狀態 AVAILABLE
。
建立連線
-
開啟終端機 (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" } -
使用主控台完成連線。如需詳細資訊,請參閱更新待定連線 。
-
管道預設為偵測將程式碼推送至連線來源儲存庫時的變更。若要設定手動發行或 Git 標籤的管道觸發組態,請執行下列其中一項操作:
-
若要將管道觸發組態設定為僅從手動版本開始,請將下列行新增至組態:
"DetectChanges": "false",
-
若要設定管道觸發組態以使用觸發條件進行篩選,請參閱 中的更多詳細資訊程式碼推送或提取請求時篩選觸發條件。例如,以下項目會新增至管道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" ] } } ] } } ]
-