yamllint-action 镜像文档

镜像概述和主要用途

yamllint-action 镜像提供 YAML 文件 linting 功能，通过检查 YAML 文件的语法正确性、格式规范性及潜在问题，帮助开发者识别并修复错误或不规范内容。该镜像对每个发现生成详细注释，适用于提升项目中 YAML 文件的质量与一致性。

核心功能和特性

• YAML 语法验证：自动检测缩进错误、非法字符、键重复等语法问题
• 格式规范检查：验证缩进空格数、行尾空格、键排序等格式规范
• 详细问题注释：生成包含位置（行号、列号）和原因的错误注释，便于定位修复
• 自定义配置支持：通过外部 .yamllint 文件自定义 linting 规则，适配项目需求
• 轻量高效：基于精简基础镜像构建，运行速度快，资源占用低

使用场景和适用范围

• CI/CD 流水线集成：代码提交或构建阶段自动检查配置文件、Kubernetes 资源清单等 YAML 文件
• 本地开发辅助：提交代码前本地检查，确保 YAML 文件符合团队规范
• 代码审查支持：提供 YAML 质量报告，减少人工检查成本
• 项目质量门禁：作为构建/部署前置条件，确保仅规范 YAML 文件进入后续流程

使用方法和配置说明

基本使用（Docker Run）

通过 docker run 运行镜像，需挂载本地 YAML 文件目录至容器内：

docker run --rm -v /本地/yaml文件目录:/workspace staffbase/yamllint-action:latest /workspace

自定义配置

挂载外部 .yamllint 配置文件自定义规则：

docker run --rm \
  -v /本地/yaml文件目录:/workspace \
  -v /本地/.yamllint:/config/.yamllint \
  -e CONFIG_FILE=/config/.yamllint \
  staffbase/yamllint-action:latest /workspace

环境变量说明

配置文件示例（.yamllint）

自定义 .yamllint 配置示例：

extends: default

rules:
  indentation:
    spaces: 2
    indent-sequences: consistent
  line-length:
    max: 120
  trailing-spaces: disable

输出说明

运行后输出检查结果，包括：

• 被检查文件路径
• 问题位置（行号:列号）
• 问题类型（如 syntax-error, indentation）
• 问题描述（如 "wrong indentation: expected 2 spaces, got 4"）

检查通过时输出 "No issues found"；存在问题时以非零 exit code 退出，便于 CI/CD 流程捕获失败。