Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juntao/code-review-pull-request
Perform automatic code reviews for GitHub pull requests (PR). The review is triggered when a PR is created and is triggered again for every subsequent commit in the PR. It will review each changed file in the PR.
https://github.com/juntao/code-review-pull-request
Last synced: about 2 months ago
JSON representation
Perform automatic code reviews for GitHub pull requests (PR). The review is triggered when a PR is created and is triggered again for every subsequent commit in the PR. It will review each changed file in the PR.
- Host: GitHub
- URL: https://github.com/juntao/code-review-pull-request
- Owner: juntao
- Created: 2023-05-18T20:14:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-18T20:14:45.000Z (over 1 year ago)
- Last Synced: 2024-11-29T21:43:19.756Z (about 2 months ago)
- Language: Rust
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh.md
Awesome Lists containing this project
README
[English](README.md)
#
ChatGPT/4 PR 代码检查机器人
[部署此函数到 flows.network](#deploy-your-own-code-review-bot-in-3-simple-steps)，你将获得一个帮你检查代码和总结拉取请求的 GitHub 机器人。它可以帮助忙碌的开源贡献者更快地理解并对 PR 采取行动!下面是一些示例!
* [[C++] 优化 WasmEdge C++ SDK](https://github.com/WasmEdge/WasmEdge/pull/2428#issuecomment-1524733889)
* [[C++] 为 WasmEdge 创建 OpenCV plugin](https://github.com/WasmEdge/WasmEdge/pull/2403#issuecomment-1509595889)
* [[Haskell] 优化 WasmEdge Component Model tooling](https://github.com/second-state/witc/pull/73#issuecomment-1509586233)
该机器人可以检查 PR 中更改的文件。 或者，可以使用[这个 bot](https://github.com/flows-network/github-pr-summary) 来总结 PR 中提交的信息。
## 如何工作
当在指定的 GitHub repo 中提出新的 PR 时，将触发此流功能（或🤖）。 flow 函数收集 PR 中的更改文件，并请 ChatGPT/4 对其进行检查和总结。 然后将结果作为评论发回 PR。 flow 函数是用 Rust 编写的，并在 [flows.network](https://flows.network/) 上在托管的 [WasmEdge Runtimes](https://github.com/wasmedge) 中运行。
* 每次将新的提交推送到此 PR 时，都会自动更新代码检查评论。
* 当有人在 PR 的注释部分中说出一个魔法*触发词*时，可以触发新的代码检查。默认的触发词是"flows summarize"。
## 简单3步部署自己的代码检查机器人
1. 从模板创建一个机器人
2. 配置机器人以检查指定 GitHub repo 中的PR
3. 授权[flows.network](https://flows.network/)访问 GitHub repo
### 0 先决条件
需要使用自己的 [OpenAI API 密钥](https://openai.com/blog/openai-api)。如果还没有注册，请[在此处注册](https://platform.openai.com/signup)。
还需要使用 GitHub 帐户登录 [flows.network](https://flows.network/)。这是免费的。
### 1 从模板创建机器人
[**单击此处**](https://flows.network/flow/createByTemplate/code-review-for-github-pull-requests)
### 2 配置机器人
* `github_owner`: 你想在其上部署🤖的 GitHub repo 的组织。*
* `github_repo` : 你想在其上部署🤖的 GitHub repo。*
>让我们看一个示例。你想要部署机器人从而总结 `WasmEdge/wasmedge_hyper_demo` repo 中的 PR。这里 `github_owner = WasmEdge`，`github_repo = wasmedge_hyper_demo`。
单击“创建和部署（Create and deploy）”按钮。
## 3 授权访问
接下来，[flows.network](https://flows.network/) 将引导你配置你的 flow 函数 🤖 所需的外部服务。
对于此 flow 函数，我们需要配置两个 integration。
单击“连接”或“+ 添加新的身份验证”按钮以添加你的 OpenAI API 密钥。
单击“连接”或“+ 添加新的身份验证”按钮，以使函数可以访问 GitHub repo 以部署🤖。你将被重定向到一个新页面，需要给 [flows.network](https://flows.network/) 授予访问 repo 的权限。
之后，单击“检查”按钮以转到 flow 详情页面。一旦 flow 的状态变为 `running`，PR 摘要 GitHub 机器人就可以开始进行代码检查。每当有新的 PR 和新的 commit ，以及在 PR 评论中出现的魔法词（即`trigger_phrase`）时，这个机器人就会被调用。
## 常见问题解答
### 自定义机器人
机器人的源代码可在你从模板克隆的 GitHub repo 中找到。请根据自己的需求任意更改源代码（例如，模型、上下文长度、API 密钥和提示）。如果需要帮助，请在 [Discord 中询问](https://discord.gg/ccZn9ZMfFf)！
### Use GPT4
默认情况下，该机器人使用 GPT3.5 进行代码审核。如果你的 OpenAI API 密钥可以访问 GPT4，则可以在克隆的源代码 repo 中打开 `src/github-pr-review.rs` 文件，并在源代码中将 `GPT35Turbo` 更改为 `GPT4`。将更改提交并推送回 GitHub。flows.network 平台将自动检测并从你的更新的源代码重建机器人。
### 在多个 repo 上使用机器人
你可以创建一个新的 flow，并导入机器人的源代码 repo（即你从模板克隆的 repo）。然后，可以使用 flow config 来指定 `github_owner` 和 `github_repo`，以指向你需要在其上部署机器人的目标 repo。部署并授权访问该目标 repo。
可以安装在你想要部署此机器人的所有目标 repo 上。
### 定制自己的魔法词
进入机器人正在运行的 flow 函数的 "Settings" 选项卡，你可以更新 `trigger_phrase` 配置。该配置的值是让用户触发机器人的魔法词，可以从 PR 评论触发检查。
## 鸣谢
此 flow 函数最初由 [Jay Chen](https://github.com/jaykchen) 创建，[jinser](https://github.com/jetjinser) 为优化来自 GitHub 的事件触发器做出了重大贡献。
