在原始碼存放區中手動建構程式碼

第 1 代 第 2 代

本頁說明如何建立手動觸發條件，在來源存放區中建構程式碼。手動觸發程序可用於手動叫用建構作業，並在執行建構作業前，於叫用時覆寫定義的替代變數值。您也可以排定手動觸發時間，讓系統在特定時間自動執行。

如要瞭解如何使用 gcloud CLI 或 Cloud Build API 手動啟動建構作業，請參閱「手動啟動建構作業」。

事前準備

• Enable the Cloud Build API.

  Enable the API

• 準備好原始碼。

手動觸發條件

手動觸發條件可讓您設定建構作業，只有在連結的存放區中叫用觸發條件時才會執行。假設您要建立管道，將原始碼部署至測試或正式環境。您可能想自動執行工作流程，但只想手動執行建構作業。您可以定義手動觸發條件來執行這項操作。

手動觸發條件可讓您透過下列方式手動叫用建構作業：

• 從指定分支版本或標記的代管存放區擷取原始碼。
• 使用替代項目將建構作業參數化，這樣每次執行建構作業時，就不必手動傳遞這些項目。
• 在叫用建構作業之前，於叫用時覆寫已定義的替代變數值。

如要從本機工作目錄執行建構作業，而非從代管存放區執行，或想提交建構作業而不建立觸發程序，可以在工作目錄中執行下列 gcloud 指令：

gcloud builds submit --config BUILD_CONFIG SOURCE_CODE

其中：

• BUILD_CONFIG 是建構設定檔的路徑。
• SOURCE_CODE 是路徑或網址原始碼。

如要進一步瞭解如何使用 gcloud 指令，在本地目錄中手動啟動建構作業，請參閱「手動啟動建構作業」。

建立手動觸發條件

主控台

如要建立手動觸發條件，請按照下列步驟操作：

1. 開啟「觸發條件」頁面：

   開啟「Triggers」(觸發條件) 頁面

2. 在頁面頂端選取專案，然後按一下「開啟」。

3. 按一下「建立觸發條件」。

4. 輸入下列觸發條件設定：

   • 名稱︰觸發條件的名稱。

   • 「區域」：選取觸發條件的區域。

     • 如果您選取「global」(全球) 做為區域，Cloud Build 會使用預設集區執行建構作業。
     • 如果您選取非全域區域，且與觸發條件相關聯的建構設定檔指定了私人集區，Cloud Build 會使用該私人集區執行建構作業。在這種情況下，您在觸發條件中指定的區域必須與您建立私人集區的區域相符。
     • 如果您選取非全球地區，且與觸發條件相關聯的建構設定檔未指定私人集區，Cloud Build 會使用預設集區，在與觸發條件相同的地區執行建構作業。

   • 說明 (選填)：觸發條件的說明。

   • 「Event」(事件)：選取「Manual invocation」(手動叫用)，設定觸發條件，這樣只有在手動叫用觸發條件時，系統才會執行建構。

   • 來源：選取手動觸發時要建構的存放區。您可以將第 1 代或第 2 代指定為來源。

     注意： 存放區的區域必須與觸發程序的區域相符。如果來源位於 Cloud Source Repositories，存放區不會連結至特定區域，而是連結至專案。

     注意：自 2024 年 6 月 17 日起，新客戶無法再使用 Cloud Source Repositories。如果貴機構先前未使用過 Cloud Source Repositories，就無法啟用 API 或使用 Cloud Source Repositories。未連結至機構的新專案無法啟用 Cloud Source Repositories API。在 2024 年 6 月 17 日前使用過 Cloud Source Repositories 的機構不會受到這項異動影響。

   • 修訂版本：選取手動觸發條件執行時要建構的分支版本或標記。

   • 分支版本：設定觸發條件，在修訂此分支版本時啟動建構。 您必須指定常值。系統目前不支援規則運算式。

   • 標記：設定觸發條件，在出現這個標記時建構。您必須指定字面值。目前不支援規則運算式。

   • 設定：選取遠端存放區中的建構設定檔，或建立內嵌建構設定檔，以用於建構作業。

     • 類型：選取要用於建構作業的設定類型。
       • Cloud Build 設定檔 (YAML 或 JSON)： 使用建構設定檔進行設定。
       • Dockerfile：使用 Dockerfile 進行設定。

     • 位置：指定設定的位置。

       • 存放區：如果設定檔位於遠端存放區，請提供建構設定檔、Dockerfile 目錄或建構套件目錄的位置。如果建構設定類型為 Dockerfile 或建構包，您需要為產生的映像檔提供名稱，並視需要設定建構作業的逾時時間。提供 Dockerfile 或建構套件映像檔名稱之後，您會看見建構將執行的 docker build 或 pack 指令預覽。
       • 內嵌：如果您選取「Cloud Build 設定檔 (yaml 或 json)」做為設定選項，可以內嵌指定建構設定。按一下「開啟編輯器」，在 Google Cloud 控制台中使用 YAML 或 JSON 語法編寫建構設定檔。按一下「完成」儲存建構設定。
       注意： Dockerfile 不支援內建建構設定。

5. 按一下「建立」即可建立手動觸發條件。

gcloud

如需完整旗標清單，請參閱gcloud參考資料，瞭解如何建立手動觸發程序。

執行手動觸發條件

主控台

如要使用 Google Cloud 控制台手動觸發，請按照下列步驟操作：

1. 在 Google Cloud 控制台中開啟「觸發條件」頁面。

   開啟觸發條件頁面

2. 在清單中找出觸發條件。

3. 按一下「執行觸發條件」。

   按一下「執行觸發條件」後，右側會顯示「執行觸發條件」視窗窗格。如果您指定了分店名稱、標記名稱或替代變數等欄位，您可以在叫用時覆寫這些欄位。

   注意： 您無法在這個視窗窗格中指定任何新欄位或變數。如要這麼做，請參閱本節「gcloud」分頁中的操作說明。

   如果您為替代項目指定了新的變數值，請按一下「執行觸發條件」來執行建構作業。

   如要依排程執行手動觸發條件，請參閱「排定建構作業」。

gcloud

如要使用 gcloud 指令列工具手動觸發，請執行下列指令：

      gcloud builds triggers run TRIGGER_NAME \
         --region=REGION \
         --branch=BRANCH_NAME \
         --substitutions=SUBSTITUTION_VAR=SUBSTITUTION_VALUE

其中：

• TRIGGER_NAME 是觸發條件的名稱。
• REGION 是觸發條件的區域。
• BRANCH_NAME 是分支名稱。您也可以使用 --tag 指定標記，或使用 --sha 指定修訂版本 ID。
• [選用]SUBSTITUTION_VAR 是替代值的變數名稱。
• [選用] SUBSTITUTION_VALUE 是與替代變數相關聯的值。

如要依排程手動觸發建構作業，請參閱「排定建構作業」。

後續步驟

• 瞭解如何使用 gcloud 指令或 Cloud Build API 手動啟動建構。
• 瞭解如何排定建構作業。
• 瞭解如何建立及管理觸發條件。
• 瞭解如何查看建構結果。
• 瞭解如何排解建構錯誤。