Pipeline Components: Yamllint 镜像文档

镜像概述与主要用途

Pipeline Components: Yamllint 是一个包含 Yamllint 工具的 Docker 镜像，旨在为 CI/CD 环境（尤其是 GitLab CI）提供便捷的 YAML 文件检查能力。Yamllint 是一款用于验证 YAML 文件语法正确性和格式规范性的工具，本镜像将其封装为容器化应用，便于集成到自动化流水线中。

核心功能与特性

核心功能

• 内置 Yamllint 工具，可直接执行 YAML 文件的语法检查和格式校验。

特性

• 轻量级设计：镜像体积优化，适合 CI/CD 环境快速拉取和启动。
• 灵活部署：Yamllint 安装于 /app/ 目录，支持自定义工具安装路径或扩展依赖。
• 无缝集成：原生支持 GitLab CI 等流水线环境，可直接作为 linting 阶段任务执行。

使用场景与适用范围

适用场景

• GitLab CI/CD 流水线：在代码提交或合并阶段自动检查项目中的 YAML 文件（如 .gitlab-ci.yml、配置文件等）。
• 本地开发环境：通过 Docker 快速运行 Yamllint，无需在本地系统安装依赖。
• 自动化构建流程：作为前置检查步骤，确保 YAML 配置文件无误后再执行后续构建或部署。

适用范围

• 需要验证 YAML 文件格式的开发或运维场景。
• 基于 Docker 的 CI/CD 流水线（如 GitLab CI、GitHub Actions 等）。

使用方法与配置说明

1. GitLab CI 集成

在 GitLab CI 流水线中，可将本镜像用于 linting 阶段，检查项目中的 YAML 文件。

示例配置（.gitlab-ci.yml）：

yaml
yamllint:
  stage: linting  # 定义阶段为 linting
  image: registry.gitlab.com/pipeline-components/yamllint:latest  # 使用最新版镜像
  script:
    - yamllint .  # 检查当前目录下所有 YAML 文件

2. Docker 命令直接运行

通过 docker run 命令在本地或其他 Docker 环境中执行 YAML 检查。

基本用法（检查当前目录）

bash
# 挂载当前目录到容器的 /workspace，检查所有 YAML 文件
docker run --rm -v "$(pwd):/workspace" pipelinecomponents/yamllint:latest yamllint /workspace

自定义配置文件

Yamllint 支持通过配置文件（如 .yamllint 或 .yamllint.yaml）定义检查规则。需将配置文件挂载到容器中，并通过 -c 参数指定。

示例：

bash
# 挂载当前目录和自定义配置文件，使用指定规则检查
docker run --rm -v "$(pwd):/workspace" pipelinecomponents/yamllint:latest \
  yamllint -c /workspace/.yamllint /workspace

3. 常用命令参数

Yamllint 支持以下常用参数（可通过 yamllint --help 查看完整列表）：

• .：检查指定目录（如 . 表示当前目录）。
• -c <config>：指定自定义配置文件路径（如 -c .yamllint）。
• -d <rules>：通过命令行直接指定检查规则（如 -d "{extends: default, rules: {line-length: {max: 120}}}"）。
• -f <format>：指定输出格式（如 standard、json、colored 等）。

版本控制

本项目采用 语义化版本（Semantic Versioning） 管理版本号，格式为 MAJOR.MINOR.PATCH。

支持与贡献

支持渠道

• 问题反馈：提交 Issue
• 社区讨论：*** 频道

贡献指南

本项目为开源项目，欢迎贡献代码或反馈建议。贡献指南详见 ***文档。

许可证

本项目基于 MIT 许可证 开源，由 Robbert Müller 维护。

镜像信息

• Docker Hub 地址：pipelinecomponents/yamllint
• 源码仓库：GitLab 仓库