docker-yamllint

yamllint 的容器镜像，由 Contane 发布。

• Docker Hub: [***]
• GitHub: [***]

镜像概述

本镜像将yamllint（一款YAML文件语法检查与格式验证工具）打包为容器化应用，基于Alpine Linux构建，默认工作目录为/data。提供yamllint非root用户以增强安全性，同时支持linux/amd64和linux/arm64两种架构平台。

核心功能与特性

• 轻量级基础：基于Alpine Linux，镜像体积小，资源占用低
• 多平台支持：同时构建并支持linux/amd64和linux/arm64架构
• 安全运行：内置yamllint非root用户，建议优先使用以遵循最小权限原则
• 灵活配置：支持通过工作目录中的.yamllint.yaml或.yamllint.yml文件自定义检查规则（配置选项详见yamllint***文档）

使用场景

• 本地命令行环境下快速检查YAML文件语法与格式
• 集成到GitHub Actions工作流，实现YAML文件的自动化校验
• 集成到GitLab CI流水线，作为代码质量检查的标准化步骤

使用方法

命令行使用

在当前目录运行yamllint检查所有文件：

docker run --rm --user yamllint -v "$(pwd):/data" contane/yamllint -f colored .

参数说明：

• --rm：容器运行结束后自动删除
• --user yamllint：指定非root用户运行
• -v "$(pwd):/data"：将本地当前目录挂载到容器的/data工作目录
• -f colored：输出带颜色的格式化检查结果
• .：检查目标为当前目录下所有文件

GitHub Actions集成

在GitHub Actions工作流中添加以下配置到.github/workflows/*.yml：

jobs:
  yamllint:
    runs-on: ubuntu-latest
    container:
      image: contane/yamllint
    steps:
      - uses: actions/checkout@v4  # 检出代码仓库
      - run: yamllint -f colored .  # 执行yamllint检查当前目录

GitLab CI集成

在GitLab CI流水线中添加以下配置到.gitlab-ci.yml：

yamllint:
  stage: test
  image:
    name: contane/yamllint
    entrypoint: ["/bin/ash", "-c"]  # 设置Alpine shell入口点
    docker:
      user: yamllint  # 使用非root用户运行
  script:
    - yamllint -f colored .  # 执行yamllint检查当前目录