通知是與您的團隊進行通訊,並讓他們知道管線在 Code Stream 中的的狀態的方式。

若要在管線執行時傳送通知,您可以根據整個管線、階段或工作的狀態設定 Code Stream 通知。

  • 電子郵件通知會在以下情況下傳送電子郵件:
    • 管線完成、正在等待、失敗、取消或啟動。
    • 階段完成、失敗或啟動。
    • 工作完成、正在等待、失敗或啟動。
  • 票證通知會建立票證,並在以下情況下將其指派給團隊成員:
    • 管線失敗或完成。
    • 階段失敗。
    • 工作失敗。
  • Webhook 通知會在以下情況下將請求傳送至其他應用程式:
    • 管線失敗、完成、正在等待、取消或啟動。
    • 階段失敗、完成或啟動。
    • 工作失敗、完成、正在等待或啟動。
例如,您可以在使用者作業工作中設定電子郵件通知,以在管線中的特定點取得核准。當管線執行時,此工作會將電子郵件傳送給必須核准工作的人員。如果使用者作業工作設定了到期逾時 (以天、小時或分鐘為單位),則所需使用者必須在工作到期前核准管線。否則,管線會按預期失敗。

若要在管線工作失敗時建立 Jira 票證,您可以設定通知。或者,若要根據管線事件向 Slack 通道傳送有關管線狀態的請求,您可以設定 Webhook 通知。

您可以在所有類型的通知中使用變數。例如,您可以在 Webhook 通知的 URL 中使用 ${var}

必要條件

  • 確認已建立一或多個管線。請參閱使用 Code Stream 的教學課程 中的使用案例。
  • 若要傳送電子郵件通知,請確認您可以存取有效的電子郵件伺服器。如需說明,請咨詢您的管理員。
  • 若要建立票證,例如 Jira 票證,請確認存在端點。請參閱什麼是 Code Stream 中的端點
  • 若要根據整合傳送通知,請建立 webhook 通知。然後,確認 webhook 已新增並正常運作。您可以將通知用於諸如 Slack、GitHub 或 GitLab 之類的應用程式。
  • 如果 webhook 連線到內部部署原始程式碼存放庫,例如 GitHub Enterprise 的內部部署執行個體,請確認存在雲端 Proxy。如需新增雲端 Proxy 的範例,請參閱設定 Code Stream 以建立發佈程序模型

程序

  1. 開啟管線。
  2. 針對整體管線狀態或某個階段或工作的狀態建立通知:
    針對以下狀態建立通知: 您執行的操作:
    管線狀態 按一下管線畫布上的空白區域。
    階段狀態 按一下管線階段中的空白區域。
    工作狀態 按一下管線階段中的工作。
  3. 按一下通知索引標籤。
  4. 按一下新增,選取通知的類型,並設定通知詳細資料。
  5. 若要在管線成功時建立 Slack 通知,請建立 webhook 通知。
    1. 選取 Webhook
    2. 若要設定 Slack 通知,請輸入資訊。
    3. 按一下儲存
      為管線完成設定 Slack 通知時,請包括 Webhook URL、動作、雲端 Proxy、裝載和標頭。
    4. 當管線執行時,Slack 通道會收到管線狀態的通知。例如,使用者可能會在 Slack 通道上看到下列內容:
      Codestream APP [12:01 AM]
      Tested by User1 - Staging Pipeline 'User1-Pipeline', Pipeline ID 'e9b5884d809ce2755728177f70f8a' succeeded
  6. 若要建立 Jira 票證,請設定票證資訊。
    1. 選取票證
    2. 若要設定 Jira 通知,請輸入資訊。
    3. 按一下儲存
      為管線失敗設定 Jira 票證通知時,請包括 Jira 專案、問題類型、受指派對象和摘要。

結果

恭喜您!您已瞭解可以在 Code Stream 的管線的數個區域中建立不同類型的通知。

下一步

如需如何建立通知的詳細範例,請參閱如何在管線工作失敗時在 Code Stream 中建立 Jira 票證