meilleursagentstech/comment-on-diff

PR差异评论GitHub Action

镜像概述

该GitHub Action旨在根据Pull Request（PR）中的代码差异自动生成并添加评论，帮助团队在代码审查过程中快速获取差异相关信息，提升协作效率。

核心功能

• 差异驱动评论：基于PR中的代码差异内容自动生成评论
• 灵活配置：支持自定义评论模板，满足不同团队的审查需求
• 无缝集成：与GitHub PR流程深度集成，触发条件可灵活设置
• 轻量高效：仅关注差异分析与评论功能，资源占用低

使用场景

• 代码审查辅助：自动标记PR中关键代码变更，辅助审查者快速定位重点
• 团队规范提醒：当代码差异违反团队规范时自动提示
• 自动化反馈：对常见变更模式（如配置文件修改、依赖更新）自动生成标准化评论
• 新手引导：为新团队成员的PR提供差异化指导建议

使用方法

基本配置

在GitHub仓库的.github/workflows目录下创建工作流文件（如pr-comment.yml），添加以下配置：

yaml
name: PR Diff Comment
on:
  pull_request:
    types: [opened, synchronize]

jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          
      - name: Add PR comment based on diff
        uses: [镜像作者/镜像名称]@v1  # 替换为实际的Action镜像地址
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # 可选配置参数
          # diff_path: "src/"  # 指定仅分析特定路径的差异
          # comment_template: "检测到以下代码变更：\n{{diff_content}}"  # 自定义评论模板

配置参数说明

自定义评论模板示例

yaml
comment_template: |
  📝 代码差异分析：
  {{diff_content}}
  
  ℹ️ 提示：请关注以上变更对[核心模块]的影响

注意事项

• 确保工作流具有pull_request事件触发权限
• github_token需包含pull_requests: write权限（默认GITHUB_TOKEN已具备）
• 对于大型PR，建议通过diff_path或ignore_pattern限制分析范围以提高效率