magnetcoop/bob

镜像概述

一个精简的Docker容器，内置各类代码检查、格式验证及发布工具的二进制文件，为开发流程和CI/CD pipeline提供一站式的代码质量检查与发布支持。

核心功能与特性

• 集成全面工具链：包含代码检查（lint）、格式验证及发布所需的核心工具，无需额外安装
• 精简设计：优化镜像体积，仅保留必要二进制文件，减少资源占用
• 多场景适配：支持JSON、YAML、Shell脚本、Dockerfile等多种文件类型的质量检查

包含的工具列表

• jsonlint：JSON文件语法检查工具
• yamllint：YAML文件语法及格式规范检查工具
• shellcheck：Shell脚本静态分析与语法检查工具
• hadolint：Dockerfile语法及最佳实践检查工具
• shfmt：Shell脚本格式化工具
• docker-compose：容器编排与服务定义工具
• aws cli：AWS云服务管理与资源操作命令行工具

适用场景

• CI/CD流程集成：作为持续集成环节的代码质量门禁，自动验证提交代码的规范性
• 本地开发辅助：为开发者提供一致的代码检查环境，避免因工具版本差异导致的校验结果不一致
• 自动化发布支持：结合docker-compose和aws cli实现应用打包与云平台发布的自动化
• 代码评审前置检查：在代码评审前进行自动化格式与语法校验，提升评审效率

使用方法

基础使用示例

通过挂载本地工作目录至容器，可直接调用工具对目标文件进行操作：

检查JSON文件语法

bash
docker run --rm -v $(pwd):/workspace bob-the-builder jsonlint /workspace/example.json

验证YAML文件格式

bash
docker run --rm -v $(pwd):/workspace bob-the-builder yamllint /workspace/config.yaml

格式化Shell脚本

bash
docker run --rm -v $(pwd):/workspace bob-the-builder shfmt -w /workspace/deploy.sh

检查Dockerfile规范

bash
docker run --rm -v $(pwd):/workspace bob-the-builder hadolint /workspace/Dockerfile

高级使用示例

在GitHub Actions中集成

yaml
jobs:
  code-quality:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run quality checks
        uses: docker://bob-the-builder
        with:
          args: >
            sh -c "
              yamllint .github/workflows/*.yml &&
              shellcheck scripts/*.sh &&
              hadolint Dockerfile
            "

结合AWS CLI发布资源

bash
docker run --rm \
  -v $(pwd):/app \
  -e AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
  -e AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
  bob-the-builder \
  aws s3 cp /app/dist s3://my-bucket --recursive

注意事项

• 工具配置文件（如.yamllint.yml、.shellcheckrc）可通过挂载本地目录传入容器，工具会自动识别并应用配置
• 涉及云服务操作（如aws cli）时，需通过环境变量或挂载凭证文件提供访问权限
• 本地文件操作需通过-v参数挂载工作目录，确保工具可访问目标文件