yaml-validator

用于验证YAML文件的CI插件

概述

yaml-validator是一个CI插件，主要用于验证YAML文件的有效性。它能够检查YAML语法正确性、处理重复键、未知标签等情况，并支持在多种CI系统中集成，确保项目中的YAML配置文件符合规范。

核心功能与特性

• 验证YAML文件的语法正确性
• 支持启用调试日志，便于问题排查
• 可配置遇到无效文件时是否继续处理
• 支持指定搜索路径，仅验证特定目录下的YAML文件
• 可配置是否允许重复键（默认不允许）
• 可配置是否忽略未知标签（默认忽略）

使用场景与适用范围

适用于需要在CI/CD流程中验证YAML文件有效性的场景，如：

• 验证项目配置文件（如docker-compose.yml、CI配置文件等）
• 在代码提交或构建前确保YAML文件格式正确
• 支持Drone、Vela、CircleCI等主流CI系统

使用方法与配置说明

Docker运行

直接通过Docker命令运行插件，验证本地YAML文件：

shell
docker run --rm \
  -e PLUGIN_DEBUG=true \
  -v 本地YAML文件路径:/work \
  -w /work \
  devatherock/drone-yaml-validator:latest

CI配置

以下参数可用于配置插件：

• debug - 启用调试日志的标志。可选，默认禁用调试日志
• continue_on_error - 遇到无效文件时是否继续处理的标志。可选，默认值为true
• search_path - 若指定，仅验证该路径下的YAML文件。可选
• allow_duplicate_keys - 是否将含重复键的YAML文件视为有效的标志。可选，默认值为false
• ignore_unknown_tags - 是否将含未知标签的YAML文件视为有效的标志。可选，默认值为true

Vela

yaml
steps:
  - name: yaml_validator
    ruleset:
      branch: master
      event: push
    image: devatherock/drone-yaml-validator:latest
    parameters:
      debug: false
      continue_on_error: true
      allow_duplicate_keys: false
      ignore_unknown_tags: true

Drone

yaml
steps:
  - name: yaml_validator
    image: devatherock/drone-yaml-validator:latest
    settings:
      debug: false
      continue_on_error: true
      allow_duplicate_keys: false
      ignore_unknown_tags: true

CircleCI

yaml
version: 2.1
jobs:
  validate_yamls:
    docker:
      - image: devatherock/drone-yaml-validator:latest
    working_directory: ~/my-repo
    environment:
      PARAMETER_DEBUG: false
      PARAMETER_CONTINUE_ON_ERROR: true
      PARAMETER_ALLOW_DUPLICATE_KEYS: false
      PARAMETER_IGNORE_UNKNOWN_TAGS: true
    steps:
      - checkout
      - run: sh /scripts/entry-point.sh

测试

要测试最新的插件镜像，运行以下命令：

shell
make functional-test