SuperAPI AI 工具集

pr-report

编程与开发

查看项目

更新于 10-27 08:25

技能介绍

用途

PR Report Generator 用于为 openshift/hypershift、openshift-eng/ai-helpers、openshift/enhancements 和 openshift/release 四个仓库生成 PR 汇总报告。它面向项目贡献者、关注项目进展的社区成员,以及在深度模式下面向管理集群运维人员和高级 SRE。

主要能力

  • 快速数据报告(自动生成):拉取各仓库已合并 PR;将 openshift/release 的 PR 过滤为仅 HyperShift 相关路径,将 openshift-eng/ai-helpers 和 openshift/enhancements 的 PR 过滤为 HyperShift 贡献者;查询 Jira 工单层级(Epic、OCPSTRAT 关联);生成时间、评审人、合并模式等指标。
  • 影响分析报告(LLM 生成):分析 PR 变更以评估实际影响,按主题和战略计划分组,为贡献者提供背景,突出重要变更、风险与跨仓库依赖。
  • 深度代码分析(--deep):拉取所选 PR 的实际代码 diff,分析代码实际改动(而不仅是描述),识别破坏性变更、API 修改、测试覆盖,并核对 PR 描述与实际变更是否一致。
  • 进展报告(--progress-report):以 Dolphin Emulator 进展报告风格生成叙事式技术博客,问题优先的叙述方式,按主题分组,并按 GitHub 账号致谢贡献者。需要 --deep。
  • 破坏性变更报告(--breaking-changes):识别含破坏性变更、API 修改或行为变化的 PR,关联完整 Jira 层级(工单 → Epic → OCPSTRAT),按客户群体和使用模式评估影响范围,并给出可操作建议(回滚、修复、记录、接受)。需要 --deep。
  • 协作报告(--deep 时始终生成):根据评审关系和共同主题将贡献者聚类,识别连接各聚类的桥接节点,每个聚类一段超短描述。
  • 博客文章(--blog):将进展报告转换为 MkDocs Material 风格博文,含网格统计卡片、提示块和图标;生成可排序的贡献者表格(含各仓库链接 PR 数和 bugfix 列);创建/更新 docs/content/blog/index.md 落地页;更新 docs/mkdocs.yml 导航;运行 make docs-aggregate 验证;对公开博客进行敏感内容过滤(不出现 S360/SFDC 引用)。需要 --progress-report。

使用方式

命令用法示例:

/pr-report                                    # 最近 7 天(默认)
/pr-report --start 2026-02-05                 # 从指定日期到今天
/pr-report --start 2026-02-05 --end 2026-02-12  # 指定日期范围
/pr-report --start 2026-02-05 --end 2026-02-12 --deep  # 含深度代码分析
/pr-report --start 2026-02-05 --end 2026-02-12 --deep --progress-report
/pr-report --start 2026-02-05 --end 2026-02-12 --deep --breaking-changes
/pr-report --start 2026-05-14 --end 2026-06-22 --deep --progress-report --blog

参数说明:

  • --start(可选):起始日期,格式 YYYY-MM-DD,默认为 7 天前。
  • --end(可选):结束日期,格式 YYYY-MM-DD,默认为今天。
  • --deep(可选):启用深度分析模式,拉取并分析实际代码 diff。
  • --progress-report(可选):生成叙事博客风格进展报告,需要 --deep。
  • --breaking-changes(可选):为管理集群运维人员和高级 SRE 生成详细破坏性变更评估报告,需要 --deep。
  • --blog(可选):在 docs/content/blog/ 生成 Material 风格博文并更新 docs/mkdocs.yml 导航,需要 --progress-report。
  • --output-dir(可选):输出文件目录;未指定时通过 AskUserQuestion 询问用户。

执行流程概要:

  1. 校验参数(如 --progress-report 缺少 --deep、--blog 缺少 --progress-report 时停止并提示)。
  2. 运行脚本拉取 PR:
python3 contrib/repo_metrics/weekly_pr_report.py $ARGUMENTS --output-dir $OUTPUT_DIR

脚本的位置参数是起始日期,技能的 --start 会映射到该位置参数。启用 --blog 时额外传 --blog-data 以生成 blog_data.json。

  1. Jira 补充(条件性):若脚本输出显示已通过 REST API 获取 Jira 数据,则跳过;否则从 PR 数据提取工单并用 MCP 工具并行查询,随后保存 jira_hierarchy.json 并重新运行脚本。
  2. 生成影响分析报告,写入 $OUTPUT_DIR/weekly_pr_report_impact.md,结构包含摘要、战略计划进展、仓库亮点、重要 PR、风险与破坏性变更、依赖与跨仓库变更、指标快照、后续计划。
  3. 深度分析(--deep):交互式选择 PR(全部 / 高价值 15–20 个 / 仅 bug 修复 / 自定义),按评分规则排序(增强提案 +200、Jira Critical/Blocker +100、Major +50、Normal +20、Minor +10、SDK/API/迁移 +30、功能 +15、OCPBUGS bug 修复 +10、任意 Jira 工单 +5、openshift/release 人工 CI 变更 +10);随后拉取 diff 并以 Task agent 分批分析。

输出文件

  • $OUTPUT_DIR/weekly_pr_report_fast.md:含指标与 PR 列表的数据报告
  • $OUTPUT_DIR/hypershift_pr_details_fast.json:原始 PR 数据
  • $OUTPUT_DIR/hypershift_pr_summary.json:供 LLM 分析的紧凑摘要
  • $OUTPUT_DIR/weekly_pr_report_impact.md:影响分析报告
  • $OUTPUT_DIR/pr_scored.json:(--score)用于深度分析的排序 PR 列表
  • .work/pr_deep/*.json:(--deep)逐 PR 数据与 diff
  • .work/pr_deep/*_analysis.json:(--deep)逐 PR 分析结果
  • .work/pr_deep_aggregated.json:(--deep)聚合分析结果
  • $OUTPUT_DIR/hypershift_progress_report_YYYY-MM-DD.md:(--progress-report)叙事进展报告
  • $OUTPUT_DIR/breaking_changes_report_YYYY-MM-DD.md:(--breaking-changes)面向 SRE 的破坏性变更评估
  • $OUTPUT_DIR/collaboration_report_YYYY-MM-DD.md:(--deep)贡献者协作聚类
  • docs/content/blog/YYYY-MM-progress-report.md:(--blog)文档站博文

适用场景

  • 定期汇总 HyperShift 相关仓库的 PR 活动与指标。
  • 向贡献者和关注者说明每周进展、主题与重要变更。
  • 深度评估特定 PR 的实际代码改动、破坏性变更和测试覆盖。
  • 面向管理集群运维人员和高级 SRE 输出破坏性变更评估与建议。
  • 生成可直接发布到文档站的进展博文。

限制

  • 仅针对上述四个 openshift 仓库,依赖仓库内的 contrib/repo_metrics/weekly_pr_report.py 脚本。
  • --progress-report 必须搭配 --deep;--blog 必须搭配 --progress-report(及 --deep)。
  • Jira 层级在未设置 JIRA_EMAIL/JIRA_TOKEN 时依赖缓存或 MCP 工具补充。
  • 其余如运行环境、权限要求、收费方式等暂未提供。