建立提取請求 - Amazon CodeCatalyst

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

建立提取請求

建立提取請求可協助其他使用者在您將程式碼變更合併到另一個分支之前,查看和檢閱您的程式碼變更。首先,您會為程式碼變更建立分支。這稱為提取請求的來源分支。確認並將變更推送至儲存庫之後,您可以建立一個提取要求,將來源分支的內容與目的地分支的內容進行比較。

您可以從特定分支、提取請求頁面或專案概觀在 Amazon CodeCatalyst 主控台中建立提取請求。從特定分支建立提取要求會自動在提取要求建立頁面上提供儲存庫名稱和來源分支。當您創建一個提取請求時,您將自動收到有關提取請求的任何更新以及合併或關閉拉取請求的電子郵件。

注意

建立提取要求時,顯示的差異在於來源分支尖端與目標分支尖端之間的差異。一旦建立了提取請求,顯示的差異將在您選擇的提取請求的修訂版本與建立提取請求時作為目的地分支提示的確認之間。有關 Git 中差異和合併基礎的更多信息,請參閱 Git 文檔git-merge-base中的。

建立提取請求時,您可以使用「為我寫入描述」功能,讓 Amazon Q 自動建立提取請求中所包含變更的說明。選擇此選項時,Amazon Q 會分析包含程式碼變更的來源分支與您要合併這些變更的目的地分支之間的差異。然後,它會創建這些更改的摘要,以及它對這些更改的意圖和影響的最佳解釋。此功能僅在美國西部 (奧勒岡) 區域適用於提 CodeCatalyst 取請求。「為我寫入描述」功能不適用於連結儲存庫中的提取要求。

注意
注意

由 Amazon 基岩提供支援: AWS 實自動濫用偵測。由於為我撰寫說明建立內容摘要、建議任務使用 Amazon Q 建立或新增功能至專案,以及使用 Amazon Q 軟體開發功能將問題指派給 Amazon Q 功能,因此使用者可以充分利用 Amazon Beddrock 中實作的控制來強制執行安全性、安全性和負責任的人工智慧 (AI)。

若要建立提取請求
  1. 導航到您的項目。

  2. 執行以下任意一項:

    • 在瀏覽窗格中,選擇 [程式],選擇 [提取要求],然後選擇 [建立提取要求]。

    • 在儲存區域首頁上,選擇 [他],然後選擇 [建立提取要求]。

    • 在專案頁面上,選擇 [建立提取要求]。

  3. 源存儲庫中,確保指定的源存儲庫是包含提交代碼的存儲庫。僅當您未從存放庫的主頁面建立提取要求時,此選項才會顯示。

  4. 在「目標」分支中,選擇要在檢閱程式碼之後將其合併到的分支。

  5. 原始碼分支中,選擇包含已提交程式碼的分支。

  6. 提取請求標題中,輸入一個標題,以幫助其他用戶了解需要審查的內容以及原因。

  7. (選擇性) 在提取要求說明中,提供問題連結或變更說明等資訊。

    提示

    您可以選擇 [為我撰寫說明], CodeCatalyst 自動產生提取要求中所包含變更的描述。您可以在將自動產生的描述新增至提取請求後,對其進行變更。

    此功能需要為空間啟用生成 AI 功能,而且連結儲存庫中的提取要求無法使用。如需詳細資訊,請參閱管理生成 AI 功能

  8. (選擇性) 在問題中,選擇「連結問題」,然後從清單中選擇問題或輸入其 ID。若要取消連結問題,請選擇「取消連結」圖示。

  9. (選擇性) 在 [必要的複查者] 中,選擇 [新增必要的審核者]。從專案成員清單中選擇要新增的專案成員。必要的審核者必須先核准變更,才能將提取請求合併到目的地分支。

    注意

    您無法同時將審核者新增為必要審核者和選擇性複查者。您無法將自己新增為審核者。

  10. (選擇性) 在 [選擇性複查者] 中,選擇 [新增選用複查者]。從專案成員清單中選擇要新增的專案成員。選用審核者不需要核准變更作為需求,才能將提取請求合併到目的地分支。

  11. 查看分支之間的差異。提取請求中顯示的差異在於源分支中的修訂版本和合併基礎之間的更改,這是在提取請求創建時目的地分支的頭部提交。如果沒有顯示任何更改,則分支可能相同,或者您可能已經為源和目標選擇了相同的分支。

  12. 當您滿意提取要求包含您要檢閱的程式碼和變更時,請選擇 [建立]。

    注意

    建立提取請求之後,您可以新增註解。註解可以新增至提取請求或檔案中的個別行,以及整個提取請求。您可以使用 @符號後面接到檔案名稱來新增資源 (例如檔案) 的連結。

若要從分支建立提取要求
  1. 瀏覽至您要在其中建立提取請求的專案。

  2. 在瀏覽窗格中,選擇 [來源存放庫],然後選擇包含要檢閱程式碼變更之分支的儲存庫。

  3. 選擇預設分支名稱旁邊的下拉箭頭,然後從清單中選擇所需的分支。若要檢視某個儲存庫的所有分支,請選擇檢視全部

  4. 選擇「其他」,然後選擇「建立提取請求」。

  5. 系統會為您預先選取存放庫和來源分支。在目標分支中,選擇一旦審核代碼,您將在其中合併代碼的分支。在提取請求標題中,輸入一個標題,以幫助其他項目用戶了解必須審查的內容以及原因。選擇性地在提取請求說明中提供更多資訊,例如貼上中相關問題的連結 CodeCatalyst,或新增您所做變更的描述。

    注意

    如果提取要求的目的地分支符合工作流程中指定的其中一個分支,則設定為針對提取要求建立事件執行的工作流程將會在建立提取要求之後執行。

  6. 查看分支之間的差異。如果未顯示任何變更,則分支可能相同,或者您可能已經為來源和目標選擇了相同的分支。

  7. (選擇性) 在問題中,選擇「連結問題」,然後從清單中選擇問題或輸入其 ID。若要取消連結問題,請選擇「取消連結」圖示。

  8. (選擇性) 在 [必要的複查者] 中,選擇 [新增必要的審核者]。從專案成員清單中選擇要新增的專案成員。必要的審核者必須先核准變更,才能將提取請求合併到目的地分支。

    注意

    您無法同時新增必要和選用的檢閱者。您無法將自己新增為審核者。

  9. (選擇性) 在 [選擇性複查者] 中,選擇 [新增選用複查者]。從專案成員清單中選擇要新增的專案成員。在提取請求合併到目的地分支之前,選用審核者不必核准變更。

  10. 如果您滿意提取請求包含您要複查的變更,並包含必要的複查者,請選擇「建立」。

如果您將任何工作流程設定為在與提取要求中的目的地分支相符的位置執行,則會在建立提取要求之後,在「提取要求詳細資訊」區域的「概觀」中看到這些工作流程執行的相關資訊。如需更多詳細資訊,請參閱 新增觸發器至工作流