adwerx/pronto-ruby

镜像概述

本镜像为一站式Ruby项目Pronto运行器，可在GitHub Actions中对Ruby项目的代码差异执行静态分析，并生成GitHub Check Run报告，帮助开发者快速发现代码问题。

核心功能

集成以下Pronto代码分析工具：

• brakeman：Ruby on Rails安全漏洞检查
• bundler_audit：Ruby依赖包安全审计
• fasterer：Ruby代码性能优化建议
• flay：代码重复度检测
• poper：Rails迁移文件检查
• rails_best_practices：Rails最佳实践检查
• rails_schema：Rails数据库 schema 检查
• reek：Ruby代码异味检测
• rubocop：Ruby代码风格检查
• scss：SCSS代码风格检查
• yamllint：YAML文件格式检查

使用场景

适用于Ruby项目在GitHub Actions中自动化执行代码质量检查，支持在代码push或pull request时触发，及时反馈代码问题。

配置说明

输入参数

密钥配置

需在GitHub Actions步骤中设置GITHUB_TOKEN环境变量，用于生成Check Run报告：

yaml
- uses: adwerx/pronto-ruby
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

自定义配置

可通过项目根目录的.pronto.yml文件配置Pronto的行为。

部署示例

默认配置（仅运行rubocop）

yaml
name: Pronto代码检查
on:
  - push
  - pull_request
jobs:
  run_pronto:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: adwerx/pronto-ruby@v1.0.0-rc3
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

指定工具运行

yaml
name: Pronto代码检查
on:
  - push
  - pull_request
jobs:
  run_pronto:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: adwerx/pronto-ruby@1.0.0-rc3
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        runners: >-
          rubocop rails_schema yamllint