本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
教學課程:搭配 GitHub 管道來源使用完整複製
您可以在 中選擇 GitHub 來源動作的完整複製選項 CodePipeline。使用此選項在管道建置動作中執行 Git 中繼資料的 CodeBuild 命令。
注意
此處描述的完整複製選項是指指定是否 CodePipeline 應該複製儲存庫中繼資料,只能由 CodeBuild 命令使用。若要使用 GitHub 使用者存取權杖
重要
作為建立管道的一部分,客戶提供的 S3 成品儲存貯體將由 CodePipeline 用於成品。(這與用於 S3 來源動作的儲存貯體不同。) 如果 S3 成品儲存貯體位於與管道帳戶不同的帳戶中,請確保 S3 成品儲存貯體由 AWS 帳戶 安全且可靠的 擁有。
在本教學課程中,您將建立連線至 GitHub 儲存庫的管道、使用來源資料的完整複製選項,以及執行複製儲存庫並執行儲存庫 Git 命令的 CodeBuild 建置。
注意
此功能不適用於亞太區域 (香港)、非洲 (開普敦)、中東 (巴林)、歐洲 (蘇黎世) 或 AWS GovCloud (美國西部) 區域。若要參考其他可用的動作,請參閱 與 的產品和服務整合 CodePipeline。如需歐洲 (米蘭) 區域中此動作的考量事項,請參閱中的備註CodeStarSourceConnection 適用於 Bitbucket Cloud GitHub、 GitHub Enterprise Server、 GitLab.com 和 GitLab 自我管理動作。
必要條件
開始之前,您必須執行以下作業:
-
使用 GitHub 您的帳戶建立 GitHub 儲存庫。
-
準備好您的 GitHub 憑證。當您使用 AWS Management Console 設定連線時,系統會要求您使用 GitHub 憑證登入。
步驟 1:建立README檔案
建立 GitHub 儲存庫後,請使用下列步驟新增README檔案。
-
登入您的 GitHub 儲存庫,然後選擇您的儲存庫。
-
若要建立新檔案,請選擇新增檔案 > 建立新檔案 。命名 檔案
README.md
. 檔案,並新增下列文字。This is a GitHub repository!
-
選擇 Commit changes (遞交變更)。
確定
README.md
檔案位於儲存庫的根層級。
步驟 2:建立管道並建置專案
在本節中,您可以採取下列動作建立管道:
-
來源階段,可連線至您的 GitHub 儲存庫和動作。
-
具有建置動作的 AWS CodeBuild 建置階段。
使用精靈建立管道
-
在 登入 CodePipeline 主控台https://console.aws.amazon.com/codepipeline/
。 -
在 Welcome (歡迎) 頁面、Getting started (入門) 頁面、或者 Pipelines (管道) 頁面上,選擇 Create pipeline (建立管道)。
-
在 Step 1: Choose pipeline settings (步驟 1:選擇管道設定) 的 Pipeline name (管道名稱) 中,輸入
MyGitHubPipeline
。 -
在管道類型 中,選擇 V1 作為本教學課程的目的。您也可以選擇 V2;但請注意,管道類型在特徵和價格方面有所不同。如需詳細資訊,請參閱管道類型。
-
在 Service role (服務角色) 中,選擇 New service role (新服務角色)。
注意
如果您選擇改用現有的 CodePipeline 服務角色,請確定您已將
codestar-connections:UseConnection
IAM許可新增至您的服務角色政策。如需 CodePipeline 服務角色的指示,請參閱新增許可至 CodePipeline 服務角色 。 -
在進階設定底下,請保留預設值。在Artifact store (成品存放區) 中,針對您為管道所選取區域中的管道,選擇 Default location (預設位置),即可使用預設成品存放區 (例如指定為預設值的 Amazon S3 成品儲存貯體)。
注意
這不是原始碼的來源儲存貯體。這是管道的成品存放區。每個管道都需要有個別成品存放區,例如 S3 儲存貯體。
選擇 Next (下一步)。
-
在 Step 2: Add source stage (步驟 2:新增來源階段) 頁面上,新增來源階段:
-
在來源提供者 中,選擇 GitHub (第 2 版)。
-
在連線 下,選擇現有的連線或建立新的連線。若要建立或管理 GitHub 來源動作的連線,請參閱 GitHub 連線。
您可以為您連至特定供應商的所有連線安裝一個應用程式。如果您已安裝 GitHub 應用程式的 AWS Connector,請選擇它並略過此步驟。
注意
如果您想要建立使用者存取權杖
,請確定您已經安裝 AWS GitHub 了應用程式的 Connector,然後讓應用程式安裝欄位保持空白。 CodeConnections 將使用使用者存取權杖進行連線。如需詳細資訊,請參閱 中的存取來源提供者 CodeBuild。 -
在儲存庫名稱 中,選擇儲存庫的名稱 GitHub。
-
在分支名稱 中,選擇您要使用的儲存庫分支。
-
請確認已選取在原始程式碼變更時啟動管道選項。
-
在輸出成品格式 下,選擇完整複製以啟用來源儲存庫的 Git 複製選項。只有 提供的動作 CodeBuild 才能使用 Git 複製選項。您將在本教學步驟 3:更新 CodeBuild 服務角色政策以使用連線課程中使用 來更新 CodeBuild 專案服務角色使用此選項的許可。
選擇 Next (下一步)。
-
-
在 Add build stage (新增建置階段) 中,新增建置階段:
-
在 Build provider (建置供應商) 中,選擇 AWS CodeBuild。允許 Region (區域) 預設為管道區域。
-
選擇建立專案。
-
在 Project name (專案名稱) 中,輸入此建置專案的名稱。
-
在 Environment image (環境映像) 中,選擇 Managed image (受管映像)。針對 Operating system (作業系統),選擇 Ubuntu。
-
針對 Runtime (執行時間),選擇 Standard (標準)。針對映像,選擇 aws/codebuild/standard:5.0。
-
對於 Service role (服務角色),選擇 New service role (新服務角色)。
注意
請注意您的 CodeBuild 服務角色的名稱。在本教學課程中,您將需要角色名稱才能完成最後一個步驟。
-
在 BuildSpec 底下,針對 Build specifications (建置規格) 選擇 Insert build commands (插入建置命令)。選擇切換以編輯器 ,並在建置命令 下貼上以下內容。
注意
在建置規格的
env
區段中,請確定 git 命令的憑證協助程式已啟用,如本範例所示。version: 0.2 env: git-credential-helper: yes phases: install: #If you use the Ubuntu standard image 2.0 or later, you must specify runtime-versions. #If you specify runtime-versions and use an image other than Ubuntu standard image 2.0, the build fails. runtime-versions: nodejs: 12 # name: version #commands: # - command # - command pre_build: commands: - ls -lt - cat README.md build: commands: - git log | head -100 - git status - ls - git archive --format=zip HEAD > application.zip #post_build: #commands: # - command # - command artifacts: files: - application.zip # - location #name: $(date +%Y-%m-%d) #discard-paths: yes #base-directory: location #cache: #paths: # - paths
-
選擇繼續至 CodePipeline。這將 CodePipeline返回主控台,並建立使用建置命令進行組態的 CodeBuild 專案。建置專案使用服務角色來管理 AWS 服務 許可。此步驟可能需要數分鐘。
-
選擇 Next (下一步)。
-
-
在 Step 4: Add deploy stage (步驟 4:新增部署階段) 頁面上,選擇 Skip deploy stage (跳過部署階段),然後再次選擇 Skip (跳過) 來接受警告訊息。選擇 Next (下一步)。
-
在 Step 5: Review (步驟 5:檢閱) 上,選擇 Create pipeline (建立管道)。
步驟 3:更新 CodeBuild 服務角色政策以使用連線
初始管道執行會失敗,因為 CodeBuild 服務角色必須更新為使用連線的許可。將codestar-connections:UseConnection
IAM許可新增至您的服務角色政策。如需在IAM主控台中更新政策的指示,請參閱 新增 Bitbucket、 GitHub GitHub Enterprise Server 或 GitLab.com 連線的 CodeBuild GitClone 許可。
步驟 4:檢視建置輸出中的儲存庫命令
-
當您的服務角色更新成功時,請在失敗的 CodeBuild 階段選擇重試。
-
管道成功執行後,在成功的建置階段,選擇檢視詳細資訊 。
在詳細資訊頁面上,選擇日誌索引標籤。檢視 CodeBuild 建置輸出。命令會輸出輸入變數的值。
命令會輸出
README.md
檔案內容、列出目錄中的檔案、複製儲存庫、檢視日誌,並將儲存庫封存為ZIP檔案。