gpt-commit-summarizer

请参阅公告博客文章。

没有时间，想立刻开始使用？请查看快速入门部分。

• 快速入门
• 故障排除
• 遇到任何 bug 吗？

gpt-commit-summarizer GitHub Action 是一款强大的工具，它利用 OpenAI 最先进的 text-davinci-003 大型语言模型，为仓库中的拉取请求所引入的更改提供摘要。通过为每个提交以及每个修改过的文件生成 Git 差异，并将其连同精心设计的提示一起发送到 OpenAI API，该操作能够生成简洁而信息丰富的摘要，从而大大提升大型代码库中的协作与理解。

随后，该操作会再次调用 OpenAI API，基于各个提交和文件差异的摘要，生成整个拉取请求的汇总摘要，并将此摘要作为评论发布在拉取请求页面上。

快速入门

自动设置

适用于所有 Git 仓库。请按照 CLI 指南操作：

npx add-gpt-summarizer@latest

注意：需要您已安装 Node.js。

手动设置

要使用此操作，您需要一个 OpenAI API 密钥。如果您还没有，请在此处注册获取 OpenAI API 密钥：这里。

获得 API 密钥后，您需要将其添加到您的 GitHub 仓库作为密钥。前往您的仓库设置，找到“Secrets”（机密）部分，点击“Add a new secret”（添加新密钥），输入密钥名称 OPENAI_API_KEY 和您的 API 密钥值。

接下来，您需要将工作流文件添加到您的仓库。创建一个名为 .github/workflows/gpt-commit-summarizer.yml 的文件（相对于 Git 根目录），并将以下内容复制进去：

name: GPT Commits summarizer
# 摘要：此操作将在拉取请求中为每个提交撰写评论，并为每个被修改的文件生成摘要，将其添加到评审页面；同时，它还会根据所有提交摘要和文件差异摘要编译出一份 PR 汇总摘要，并删除过时的代码评审评论。

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  summarize:
    runs-on: ubuntu-latest
    permissions: write-all  # 某些仓库可能需要这一行

    steps:
      - uses: KanHarI/gpt-commit-summarizer@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

此工作流文件指示 GitHub 在每次打开或更新拉取请求时运行该操作。

就是这样！现在您已经可以在自己的仓库中使用 gpt-commit-summarizer 操作了。每当有新的拉取请求被打开或更新时，该操作将自动为每个提交生成更改摘要，在评审页面上添加每个被修改文件的摘要，整合所有提交摘要和文件差异摘要以生成 PR 汇总，并删除过时的代码评审评论。

故障排除

我听说过一些未经证实的报告，称 OpenAI API 可能会阻止来自某些运行器 IP 地址的请求。如果遇到此类问题，您可以尝试使用自托管运行器来执行 gpt-commit-summarizer 操作。具体做法是在您控制的服务器上设置一个运行器，然后将其添加到您的仓库中。

要设置自托管运行器，您需要执行以下步骤：

• 在您的服务器上安装 GitHub Actions Runner。请按照文档中的说明进行操作。
• 将自托管运行器添加到您的仓库。同样，请遵循文档中的说明。
• 修改工作流文件以使用自托管运行器。打开 .github/workflows/gpt-commit-summarizer.yml 文件，添加 runs-on 字段，指定您想要使用的自托管运行器。例如：

name: GPT Commits summarizer
# 摘要：此操作将在拉取请求中为每个提交撰写评论，并为每个被修改的文件生成摘要，将其添加到评审页面；同时，它还会根据所有提交摘要和文件差异摘要编译出一份 PR 汇总摘要，并删除过时的代码评审评论。

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  summarize:
    runs-on: self-hosted
    permissions: write-all  # 某些仓库可能需要这一行

    steps:
      - uses: KanHarI/gpt-commit-summarizer@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

遇到任何 bug 吗？

如果您遇到任何 bug 或有任何改进建议，请在仓库中提交一个问题。或者，您也可以通过我的电子邮件与我联系。

许可证

本项目采用 MIT 许可证授权。

gpt-commit-summarizer 快速上手指南

gpt-commit-summarizer 是一个强大的 GitHub Action 工具，利用 OpenAI 的大语言模型（text-davinci-003）自动分析 Pull Request (PR) 中的代码变更。它能生成每个提交（commit）和修改文件的摘要，并汇总成一份完整的 PR 评论，帮助团队更高效地理解大型代码库的变更。

环境准备

在开始之前，请确保满足以下条件：

• GitHub 仓库权限：你需要拥有目标仓库的管理员或写入权限，以便配置 Secrets 和工作流。
• Node.js（仅自动安装模式需要）：如果你选择使用 CLI 工具进行自动设置，本地需安装 Node.js。
• OpenAI API Key：必须拥有一个有效的 OpenAI API 密钥。如果没有，请前往 OpenAI 官网 注册获取。

安装步骤

1. 配置 OpenAI API 密钥

为了安全起见，切勿将 API 密钥硬编码在代码中。请将其添加为 GitHub Repository Secret：

1. 进入你的 GitHub 仓库页面。
2. 点击 Settings（设置） > Secrets and variables > Actions。
3. 点击 New repository secret（新建仓库密钥）。
4. 填写以下信息：
   • Name: OPENAI_API_KEY
   • Value: 你的 OpenAI API 密钥字符串。
5. 点击 Add secret 保存。

2. 添加工作流文件

你可以通过以下两种方式之一将工具集成到仓库中：

方式 A：自动安装（推荐，需本地有 Node.js）

在终端中进入你的项目根目录，运行以下命令自动创建配置文件：

npx add-gpt-summarizer@latest

方式 B：手动安装

在项目根目录下创建文件 .github/workflows/gpt-commit-summarizer.yml，并将以下内容复制进去：

name: GPT Commits summarizer
# Summary: This action will write a comment about every commit in a pull request, as well as generate a summary for every file that was modified and add it to the review page, compile a PR summary from all commit summaries and file diff summaries, and delete outdated code review comments

on:
  pull_request:
    types: [opened, synchronize]

jobs:
  summarize:
    runs-on: ubuntu-latest
    permissions: write-all  # Some repositories need this line

    steps:
      - uses: KanHarI/gpt-commit-summarizer@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

基本使用

配置完成后，无需额外操作，工具会自动运行。

1. 触发机制：当你向仓库发起一个新的 Pull Request (opened) 或向现有 PR 推送新代码 (synchronize) 时，GitHub Actions 会自动触发该工作流。
2. 查看结果：
   • 工作流运行结束后，机器人会在该 PR 的对话区发表一条评论。
   • 评论内容包含：每个 Commit 的变更摘要、每个修改文件的差异摘要，以及基于所有信息生成的整体 PR 总结。
   • 工具还会自动清理过时的代码审查评论，保持讨论区整洁。

示例场景： 开发者提交了一个包含复杂逻辑重构的 PR。合并前，维护者查看 gpt-commit-summarizer 生成的评论，快速了解了核心改动点，无需逐行阅读所有 Diff，从而加速了代码审查流程。