configlet 工作流


configlet 工作流使用 configlet 工具 检查轨道的(配置)文件结构是否正确,包括语法和语义两方面。 具体做法是运行configlet lint。

启用文件格式检查

轨道可以使用configlet fmt来格式化轨道的各种配置文件。 同一条命令也可以用来检查所有配置文件是否已正确格式化。

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工作流还会验证轨道配置文件是否已正确格式化。

来源

工作流定义在.github/workflows/configlet.yml文件中。