用 GitHub Actions 驗證變更

已完成

提示

有關更多詳細信息,請參閱 文本和圖像 選項卡!

採用主幹型開發後,每一項提議的變更都會經過提取要求。 這個拉取請求同時也是執行自動檢查的自然時刻。 會破壞訓練腳本的變更不應該進到 main,審查者也不該得手動找出每一個程式碼錯誤。

工作流程、觸發器與品質閘門

GitHub Actions 的 工作流程是儲存在你的存放庫中 .github/workflows/ 下的 YAML 檔案。 它定義了執行什麼、何時執行以及順序。 觸發器(on: 鍵)會告訴 GitHub 何時開始執行。

對於 Proseware 的驗證工作流程, pull_request 觸發器符合任務需求。 預設情況下,當拉取請求開啟、重新開啟或接收新提交時,該程序會執行。 其結果會在 Pull Request 上顯示為狀態檢查。

作業、執行器與步驟

工作流程將工作組織成 工作。 每個工作都運行在一個執行器上——由 GitHub 提供的虛擬機器,或是你組織管理的虛擬機器。 工作包含有序的 步驟 ,包括檢查倉庫、安裝工具並執行指令。

對於Proseware訓練程式碼,驗證工作可能包括:

  1. 可以看看這個資料庫。
  2. 安裝一套程式碼檢查工具(例如 Python 的 Flake8),然後用它檢查訓練腳本。
  3. 執行單元測試(例如 Pytest)來驗證腳本函式的正確行為。

這些步驟會自動執行在每次拉取請求中。 不需要有人特地記得要在本機執行。

需要進行檢查

自動執行檢查只是保護的一半。 另一半則是讓這些檢查進行封鎖。 在分支保護設定中,「 合併前要求狀態檢查通過 」選項可以讓你指定特定職缺。 提取要求必須等到該些具名作業成功後才能合併。

基於主幹的開發與必要的狀態檢查共同構成一個品質門檻:資料科學家開啟拉取請求,工作流程執行,合併按鈕則保持停用狀態直到程式碼通過。

提示

狀態檢查會以工作流程檔案中的 工作名稱 來識別。 使用明確且穩定的名稱,這樣在分支保護設定中容易找到。

提示

想像一下一個有有效 Python 語法但輸出錯誤的預處理變更。 哪種檢查能偵測風格問題,哪種檢查必須驗證行為?