configlet 工作流


configlet 工作流會使用 configlet 工具 來檢查 track 的(設定)檔案在結構上是否正確,無論是語法還是語意。 它是透過執行configlet lint 來完成這件事。

啟用檔案格式檢查

Track 可以使用configlet fmt 來格式化 track 的各種設定檔。 同一個指令也可以用來檢查所有設定檔的格式是否正確。

configlet 工作流支援驗證設定檔的格式是否正確,但這是選用的,預設為停用。 若要選擇啟用設定檔格式的驗證,請依照下列步驟:

  1. 建立一個 .github/org-wide-files-config.toml 檔案,內容如下
[configlet]
fmt = true
  1. 這個檔案合併到 main 之後,系統會自動開啟一個 PR,修改 configlet.yml 工作流如下:
  jobs:
    configlet:
      uses: exercism/github-actions/.github/workflows/configlet.yml@main
+     with:
+       fmt: true
  1. 這個 PR 合併之後,configlet 工作流也會驗證 track 設定檔的格式。

來源

工作流定義在 .github/workflows/configlet.yml 檔案中。