訂閱版本通知

當建構作業狀態變更時 (例如建構作業建立、轉換至工作狀態及完成時),Cloud Build 會在 Google Pub/Sub 主題上發布訊息。每個訊息都包含 message.data 屬性中建構資源的 base64 JSON 字串表示法。您可以在 message.attributes 欄位中找到建構作業的專屬 ID 和狀態。

根據預設,訊息會發布至 cloud-builds 主題;您也可以在建構設定檔的 options.pubsubTopic 欄位中指定自訂主題名稱。如要進一步瞭解如何在建構設定檔中設定主題名稱,請參閱「用於建構作業通知的 Pub/Sub 主題」。

Pub/Sub 訂閱項目可採用推送或提取模式。

接收建構作業通知

如要接收建構作業通知,請按照下列步驟操作:

  1. 啟用 Cloud Build API

    啟用 Cloud Build API

    在多數情況下,啟用 Cloud Build API 時,系統會自動將 Cloud Build 服務代理服務帳戶新增至專案。服務帳戶可讓您接收 Pub/Sub 的建構作業通知。

    服務帳戶的格式如下,其中 project-number 是專案編號:

     service-project-number@gcp-sa-cloudbuild.s3ns-system.iam.gserviceaccount.com
    

    如果 IAM 頁面未顯示 Cloud Build 服務代理服務帳戶,或您無法接收 Pub/Sub 的通知,請按照下列步驟將 Cloud Build 服務代理服務帳戶新增至專案:

    1. 在 Cloud de Confiance 控制台中,開啟「IAM」頁面:

      開啟 IAM 頁面

    2. 按一下「授予存取權」。

    3. 新增下列主體,其中 project-number 是您的專案編號:

      service-project-number@gcp-sa-cloudbuild.s3ns-system.iam.gserviceaccount.com
      
    4. 依序選取「服務代理」>「Cloud Build 服務代理」做為角色。

    5. 按一下「儲存」。

  2. 啟用 Pub/Sub API:

    啟用 Pub/Sub API

  3. 建立 cloud-builds 主題:

    gcloud pubsub topics create cloud-builds
    

    您也可以在建構設定檔中定義自訂主題名稱,將訊息改為傳送至自訂主題。在這種情況下,您會建立一個自訂主題名稱相同的主題:

    gcloud pubsub topics create topic-name
    

    詳情請參閱「要接收建構作業通知的 Pub/Sub 主題」。

    如要進一步瞭解如何管理 Pub/Sub 主題,請參閱「管理主題和訂閱項目」。

推送訂閱項目

推送訂閱項目會將訊息傳送至您定義的 HTTP 端點,訊息會在發佈至主題時立即送出。

從推送訂閱項目送出的訊息如下所示:

{
  "message": {
    "attributes": {
      "buildId": "abcd-efgh...",
      "status": "SUCCESS"
    },
    "data": "SGVsbG8gQ2xvdWQgUHViL1N1YiEgSGVyZSBpcyBteSBtZXNzYWdlIQ==",
    "messageId": "136969346945"
  },
  "subscription": "projects/myproject/subscriptions/mysubscription"
}

提取訂閱項目

提取訂閱項目會在訂閱應用程式提取時傳送訊息,訊息會在提取訂閱項目時送出。

從提取訂閱項目送出的訊息如下所示:

{
  "receivedMessages": [
    {
      "ackId": "dQNNHlAbEGEIBERNK0EPKVgUWQYyODM2LwgRHFEZDDsLRk1SK...",
      "message": {
        "attributes": {
          "buildId": "abcd-efgh-...",
          "status": "SUCCESS"
        },
        "data": "SGVsbG8gQ2xvdWQgUHViL1N1YiEgSGVyZSBpcyBteSBtZXNzYWdlIQ==",
        "messageId": "19917247034"
      }
    }
  ]
}

訂閱建構作業更新通知

您可以透過多種方式訂閱建構作業更新通知。例如,您可以將訊息推送至端點,或編寫 Python 應用程式來輪詢訂閱項目。

如要瞭解如何設定 Pub/Sub 訂閱項目來接收建構作業更新,請參閱「Pub/Sub 訂閱端指南」。您也可以瞭解 Pub/Sub 用戶端程式庫,讓開發訂閱者應用程式更輕鬆。

如要瞭解如何使用 Pub/Sub 將建構作業更新傳送至電子郵件或 Slack 等服務,請參閱「Cloud Build 通知工具」。