configletワークフロー


configletワークフローは、configletツールを使って、トラックの(設定)ファイルが構文的にも意味的にも正しく構成されているかをチェックします。 これはconfiglet lintを実行することで行われます。

ファイルのフォーマットチェックを有効にする

トラックでは、configlet fmtを使って、トラックのさまざまな設定ファイルをフォーマットできます。 同じコマンドは、すべての設定ファイルが正しくフォーマットされているかどうかのチェックにも使えます。

configletワークフローは、設定ファイルが正しくフォーマットされているかを検証できますが、これは任意で、デフォルトでは無効になっています。 設定ファイルのフォーマットの検証をオプトインするには、次の手順に従います。

  1. 次の内容で.github/org-wide-files-config.tomlファイルを作成します
[configlet]
fmt = true
  1. このファイルがmainにマージされると、configlet.ymlワークフローを次のように変更するPRが自動的に開かれます。
  jobs:
    configlet:
      uses: exercism/github-actions/.github/workflows/configlet.yml@main
+     with:
+       fmt: true
  1. このPRがマージされると、configletワークフローでもトラックの設定ファイルのフォーマットが検証されるようになります。

ソース

ワークフローは.github/workflows/configlet.ymlファイルで定義されています。