uhafner/quality-monitor

quality-monitor GitHub Action

1. 镜像概述和主要用途

quality-monitor 是一款 GitHub Action，用于基于可配置的指标集监控项目质量，并在 GitHub 拉取请求（Pull Request）或单个提交上提供质量反馈。该 Action 是 Jenkins Warnings 和 Coverage 插件的独立版本，专为 GitHub Actions 环境设计，可无缝集成到任何使用 GitHub Actions 的 GitHub 项目中，实现轻量级、自动化的项目质量监控。

2. 核心功能和特性

• 可配置指标集：支持通过自定义配置定义项目质量监控指标（如代码警告数量、测试覆盖率、代码复杂度等）。
• PR/提交反馈：自动分析拉取请求或单个提交的质量数据，并生成直观反馈，帮助开发者及时掌握代码质量变化。
• Jenkins 插件独立化：移植自 Jenkins Warnings 和 Coverage 插件的核心功能，无需依赖 Jenkins 环境即可独立运行。
• GitHub Actions 兼容：专为 GitHub Actions 生态设计，支持主流操作系统运行环境（如 Ubuntu、macOS、Windows）。

3. 使用场景和适用范围

适用项目

• 采用 GitHub Actions 作为 CI/CD 工具的 GitHub 项目。

核心场景

• 代码审查流程中，自动评估拉取请求的质量是否符合项目标准。
• 监控每次代码提交对项目质量指标的影响，及时发现质量退化问题。
• 替代或补充基于 Jenkins 的质量监控流程，降低环境依赖复杂度。

4. 使用方法和配置说明

4.1 前置条件

• 项目已配置 GitHub Actions（即仓库中存在 .github/workflows/ 目录及有效的 workflow 文件）。
• 根据监控指标需求，项目需能生成对应的质量数据文件（如编译器警告日志、测试覆盖率报告等）。

4.2 基本配置步骤

步骤 1：在 Workflow 中引用 Action

在 GitHub Actions workflow 文件中，通过 uses 关键字引用该 Action。

步骤 2：配置监控参数

通过 with 关键字指定监控指标、阈值、反馈方式等参数（具体参数需参考项目官方文档）。

4.3 示例 Workflow 配置

以下是在拉取请求和代码推送事件中触发质量监控的示例配置：

yaml
name: Project Quality Monitor
on:
  pull_request:
    branches: [ "main", "develop" ]
  push:
    branches: [ "main", "develop" ]

jobs:
  quality-monitor:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      # 步骤：构建项目并生成质量数据（根据项目类型调整）
      - name: Build and generate quality reports
        run: |
          # 示例：运行测试并生成覆盖率报告、编译代码生成警告日志
          ./gradlew test jacocoTestReport compileJava

      # 步骤：运行 quality-monitor Action
      - name: Run quality monitor
        uses: uhafner/quality-monitor@v1  # Action 引用路径（需替换为实际版本）
        with:
          # 配置监控指标（示例：警告和覆盖率）
          metrics: "warnings,coverage"
          # 指标数据文件路径（根据项目构建输出调整）
          warnings-path: "build/reports/compilerWarnings.txt"
          coverage-path: "build/reports/jacoco/test/jacocoTestReport.xml"
          # 质量阈值配置（示例：警告数量≤20，覆盖率≥80%）
          thresholds: |
            {
              "warnings": {"max": 20},
              "coverage": {"min": 80}
            }
          # 反馈方式：在 PR 中添加评论
          feedback-target: "pr-comment"

4.4 配置参数说明

4.5 更多详情

完整配置说明及最新版本信息，请参考项目官方文档：https://github.com/uhafner/quality-monitor