welltravel/pronto-action

GitHub Pronto Action Docker 镜像文档

概述

GitHub Pronto Action 是专为 GitHub Actions 设计的 Docker 镜像，旨在将 Pronto 轻量级代码审查工具无缝集成到 CI/CD 工作流程中。Pronto 聚焦于分析 Git 仓库中的变更文件（而非全量代码），结合 RuboCop、ESLint、flake8 等主流静态分析工具，可在代码提交或 PR 创建阶段快速定位潜在问题，帮助团队提升代码质量与开发效率。

核心功能与特性

1. 高效变更文件分析

仅针对 Git 仓库中未提交的变更或指定分支间的差异文件进行扫描，避免全量代码分析，大幅减少资源消耗和审查时间。

2. 多静态分析工具支持

通过 Pronto 插件系统兼容多种语言的静态分析工具，包括但不限于：

• Ruby：RuboCop、Reek、Fasterer
• JavaScript/TypeScript：ESLint、Prettier
• Python：flake8、pylint
• Java：Checkstyle
• Go：golint、staticcheck

3. GitHub 生态集成

• 支持将审查结果直接评论至 GitHub PR（需配置 GitHub Token），实现审查结果可视化。
• 兼容 GitHub Actions 事件触发机制（如 push、pull_request），可按需触发审查流程。

4. 高度可配置

支持通过环境变量或配置文件自定义分析规则、工具组合、忽略文件/目录等，适配不同项目的个性化需求。

适用场景

• 代码提交前检查：在 push 事件触发时自动分析变更文件，防止问题代码进入仓库。
• PR 质量门禁：在 pull_request 事件中作为合并前置检查，确保代码符合团队规范。
• 团队协作优化：将审查结果直接反馈至 PR 评论区，减少人工审查成本，加速评审流程。

使用方法

1. 本地 Docker 运行示例

本地测试或非 GitHub Actions 环境使用时，通过 docker run 命令运行：

bash
docker run --rm \
  -v $(pwd):/app \  # 挂载本地代码目录至容器内 /app
  -e GITHUB_TOKEN="your_github_token" \  # 可选，用于 PR 评论
  -e PRONTO_RUNNERS="eslint,rubocop" \  # 逗号分隔的静态分析工具列表
  -e BASE_BRANCH="main" \  # 基准分支，默认 main
  -e IGNORE_PATHS="node_modules/**,vendor/**" \  # 可选，忽略目录
  github-pronto-action:latest

2. GitHub Actions 工作流配置示例

在仓库 .github/workflows/ 目录下创建工作流文件（如 pronto-review.yml）：

yaml
name: Pronto Code Review

on:
  push:
    branches: [ "main", "develop" ]
  pull_request:
    branches: [ "main", "develop" ]

jobs:
  pronto-review:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # 获取完整历史以比较分支差异

      - name: Install dependencies
        run: |
          # 按需安装静态分析工具依赖（示例为 Node.js 项目）
          npm install

      - name: Run Pronto review
        uses: docker://github-pronto-action:latest
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # 用于 PR 评论
          PRONTO_RUNNERS: "eslint"  # 指定分析工具
          BASE_BRANCH: "main"  # 基准分支
          IGNORE_PATHS: "node_modules/**"  # 忽略目录

配置参数与环境变量

注意事项

• 依赖前置安装：需确保项目中已安装静态分析工具依赖（如 npm install 安装 ESLint），建议通过前置步骤完成依赖安装。
• 代码目录访问：容器需访问代码仓库目录，GitHub Actions 中通过 actions/checkout 自动挂载，本地运行需手动挂载 -v $(pwd):/app。
• Token 权限：若需评论 PR，GITHUB_TOKEN 需具备 pull_requests: write 权限，GitHub Actions 默认令牌已包含此权限。