physitrack/ci-rubocop

ci-rubocop 镜像文档

镜像概述

ci-rubocop是一个独立的Docker镜像，集成了https://github.com/rubocop/rubocop%EF%BC%88Ruby%E4%BB%A3%E7%A0%81%E9%9D%99%E6%80%81%E5%88%86%E6%9E%90%E5%B7%A5%E5%85%B7%EF%BC%89%E3%80%81https://github.com/prontolabs/pronto%EF%BC%88%E8%BD%BB%E9%87%8F%E7%BA%A7%E4%BB%A3%E7%A0%81%E5%AE%A1%E6%9F%A5%E5%B7%A5%E5%85%B7%EF%BC%89%E5%8F%8Ahttps://github.com/prontolabs/pronto-rubocop%EF%BC%88pronto%E7%9A%84rubocop%E6%8F%92%E4%BB%B6%EF%BC%89%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E4%BB%8E%E4%B8%BB%E4%BB%93%E5%BA%93%E6%8F%90%E5%8F%96%EF%BC%8C%E4%B8%93%E4%B8%BA%E5%9C%A8CI%E7%8E%AF%E5%A2%83%E6%88%96%E6%9C%AC%E5%9C%B0%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83%E4%B8%AD%E9%80%9A%E8%BF%87%E5%91%BD%E4%BB%A4%E8%A1%8C%E6%89%A7%E8%A1%8C%E4%BB%A3%E7%A0%81%E8%B4%A8%E9%87%8F%E6%A3%80%E6%9F%A5%E8%80%8C%E8%AE%BE%E8%AE%A1%E3%80%82

核心功能与特性

• 集成rubocop：提供Ruby代码风格和质量的静态分析，支持自定义规则配置
• 包含pronto：轻量级代码审查工具，可针对代码变更（如提交或分支差异）进行增量检查
• pronto-rubocop插件：将rubocop分析能力集成到pronto中，实现针对性的代码质量反馈
• 独立运行：无需额外安装依赖，可直接在命令行环境使用

使用场景

• CI/CD流程：在持续集成过程中自动检查代码风格和质量，确保合并前代码符合规范
• 本地开发：开发人员在提交代码前进行本地检查，提前发现并修复代码风格问题
• 代码审查辅助：针对特定分支或提交的代码变更进行定向分析，提高审查效率

使用方法

本地开发环境使用

基础rubocop检查

挂载代码目录并运行完整的rubocop分析：

bash
docker run --rm -v $(pwd):/app ci-rubocop rubocop /app

使用pronto检查代码变更

检查当前分支与main分支的差异：

bash
docker run --rm -v $(pwd):/app \
  -v ~/.ssh:/root/.ssh \  # 挂载SSH密钥（如需访问私有仓库）
  ci-rubocop pronto run origin/main --exit-code

CI环境配置示例

GitLab CI配置

在.gitlab-ci.yml中添加代码质量检查阶段：

yaml
code_quality:
  image: ci-rubocop
  script:
    - pronto run origin/main --exit-code
  only:
    - merge_requests
    - main

GitHub Actions配置

创建.github/workflows/rubocop.yml：

yaml
name: Rubocop Check
on: [pull_request, push]

jobs:
  rubocop:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run rubocop via ci-rubocop
        uses: docker://ci-rubocop
        with:
          args: pronto run origin/${{ github.base_ref }} --exit-code

注意事项

• 确保挂载的代码目录具有正确的读写权限，避免因权限问题导致文件访问失败
• 使用pronto时，需确保容器内可访问Git仓库（可通过挂载SSH密钥或配置HTTPS凭证实现）
• 可通过在代码目录中添加.rubocop.yml文件自定义rubocop规则
• --exit-code参数使pronto在发现问题时返回非零退出码，便于CI流程中断