有没有办法可以验证 Github 上的 YAML 文件？

Question

我目前正在开发 Ruby on Rails 应用程序。我有一个目录，里面充满了不时编辑的不同 Yaml 文件。每当开发人员意外地将无效的 Yaml 语法合并到主分支时。整个应用程序崩溃了。

无论如何，我是否可以在 Github 上设置一个 Yaml 验证器，检查我的 Repo 中特定目录中的 Yaml 文件的有效性，并在该 Yaml 验证器检查失败时阻止 PR 合并到 Main 中？

Answer 1

一种更通用的方法，无需使用 Github Hooks。

我目前使用的一种选择是overcommit。它有很多可以在 a 之前执行的钩子git commit（除其他外）。

对于您的场景，这应该可行。

YamlSyntax:
   enabled: true
   description: 'Check YAML syntax'
   required_library: 'yaml'
   include:
     - '**/*.yaml'
     - '**/*.yml'

以下是这些钩子的列表： https: //github.com/sds/overcommit/blob/master/config/default.yml。

你可以添加 rubocop、sorbet 等。这只有在整个团队都安装了它的情况下才有效，否则那些拥有它的人很可能需要修复其他团队成员遗漏的东西。