移除成品、建立狀態徽章和設定環境保護

已完成

在此單元中,您會了解如何從 GitHub 移除工作流程成品,以及變更預設保留期間。 接下來,了解如何建立工作流程狀態徽章,並將其新增至您的 README.md 檔案。 最後,識別一些重要的工作流程環境保護,以及了解如何加以啟用。

從 GitHub 移除工作流程成品

依預設,GitHub 會在刪除之前儲存任何組建記錄檔和已上傳的成品 90 天。 您可以根據存放庫的類型和針對特定 GitHub 產品所設定的使用量限制,來自訂此保留期間。 有很多關於使用量限制和成品保留的詳細資訊。 如需詳細資訊,請參閱使用量限制、計費和管理

但假設您達到您的組織的 GitHub 成品和套件儲存體限制。 您想要移除舊成品,而不增加使用量限制並封鎖您的工作流程。 您可以在 GitHub 上的成品過期前,先刪除成品,以回收已使用的 GitHub Actions 儲存體。 您可以透過下列各節所述的兩種方式執行這項作業。 這兩種方法都需要存放庫的寫入權限。

警告

請記住,一旦您刪除成品,就無法還原。

從您的存放庫手動刪除成品

若要在 GitHub 上手動刪除成品,請瀏覽至 [Actions] \(動作\) 索引標籤,從左側邊欄中選取工作流程,然後選取您想要查看的流程執行作業。

螢幕擷取畫面,顯示 GitHub 上的範例工作流程執行。

在 [Artifacts] (成品) 下,刪除您想要移除的成品。

螢幕擷取畫面,顯示刪除 GitHub 上成品的垃圾桶圖示。

您也可以使用 Artifacts REST API 來刪除成品。 此 API 也可讓您下載和擷取工作成品的相關資訊。

變更預設保留期間

您可以變更存放庫、組織或企業帳戶的預設成品和記錄保留期間。 請記住,變更保留期間僅適用新的成品和記錄檔。 它不適用現有的物件。 針對存放庫、組織或企業,設定這些設定的流程有點不同。 如需設定成品和記錄保留的詳細資訊,請參閱此課程模組結尾的摘要。

除了跨存放庫、組織或企業設定的設定之外,您還可以直接在工作流程檔案內定義個別成品的自訂保留期間。 此做法適用於您想要特定成品的保留與預設或設定的設定不同時的個別使用案例。 您可以在進行 upload-artifact 動作的步驟時,使用 retention-days 值來執行這項作業。

下列範例會上傳將保存 10 天的成品,而不是預設的 90 天:

- name: 'Upload Artifact'
  uses: actions/upload-artifact@v2
  with:
    name: my-artifact
    path: my_file.txt
    retention-days: 10

將工作流程狀態徽章新增至您的存放庫

無需前往 [Actions] (動作) 索引標籤查看其是否已順利完成,即可了解工作流程的狀態相當有幫助。 將工作流程狀態徽章新增至您存放庫的 README.md 檔案,可讓您快速查看您的工作流程是否通過或失敗。 雖然通常會將狀態徽章新增至存放庫的 README.md 檔案,但您也可以將其新增至任何網頁。 根據預設,狀態徽章會顯示預設分支上的工作流程狀態,但您也可以使用 branchevent 參數,顯示其他分支上的工作流程狀態徽章。

以下範例是要查看工作流程狀態徽章,您必須新增至檔案的內容:

![example branch parameter.](https://github.com/mona/special-octo-eureka/actions/workflows/grading.yml/badge.svg?branch=my-workflow)

例如,在 URL 結尾處新增 branch 參數與所需的分支名稱將會顯示該分支的工作流程狀態徽章,而不是預設分支。 此做法可讓您輕鬆地在 README.md 檔案內建立類似資料表的檢視,以顯示以分支、事件、服務或環境為基礎的工作流程狀態。

螢幕擷取畫面,顯示 my-workflow 分支的範例工作流程狀態徽章。

您也可以使用 GitHub 建立狀態徽章。 瀏覽至 [動作] 索引標籤中的工作流程區段,然後選取特定工作流程。 [建立狀態徽章] 選項可讓您產生該工作流程的 Markdown,並設定 branchevent 參數。

螢幕擷取畫面,顯示從 GitHub 上的工作流程區段建立狀態徽章的選項。

新增工作流程環境保護

安全性相當重要,因此使用保護規則和祕密來設定工作流程環境相當合理。 有了這些元素,在通過所有環境保護規則之前,工作都不會啟動或存取環境中定義的任何祕密。 保護規則和環境祕密目前僅適用於公有存放庫。

有兩個環境保護規則可套用至公用存放庫內的工作流程:required reviewers (需要檢閱者) 和 wait timer (等候計時器)。

  • Required reviewers (需要檢閱者) 可讓您設定特定人員或小組,以核准參考作業環境的工作流程作業。
  • Wait timer (等候計時器) 可用來在作業觸發之後,延遲一段特定的時間。

例如,假設您需要在實際執行環境中建立部署之前需經開發小組核准的工作流程。 使用下列步驟:

  1. 在存放庫中建立實際執行環境。
  2. 設定需要檢閱者環境保護,要求特定開發小組的核准。
  3. 在工作流程中設定特定作業,以尋找實際執行環境。

您可以從存放庫 [Settings] (設定) 索引標籤下方的 [Environments] (環境) 建立及設定新的存放庫環境。