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