README-zh.md

English

ChatGPT/4 加成的 Github PR 代码检查机器人

部署此函数到 flows.network，你将获得一个 GitHub 🤖 来检查代码和总结拉取请求。它可以帮助忙碌的开源贡献者更快地理解并对 PR 采取行动!下面是一些示例!

• [Rust] 支持 WasmEdge Rust SDK 中的主机函数
• [bash] 支持 WasmEdge 安装程序中的 ARM 体系结构
• [C++] 为 WasmEdge 添加 eBPF 插件
• [Haskell] 优化 WasmEdge Component Model 工具的 CLI 实用程序

还没被惊艳到吗？请见此处 bot 指出的“潜在问题1”，它识别出了 Rust 算法的低效实现。🤯

这个机器人会总结 PR 中提交的信息。或者，可以使用这个机器人来检查PR中更改的文件。

如何工作

当在指定的 GitHub repo 中创建新的 PR 时，此 flow 函数（或🤖）将被触发。 flow 函数会收集 PR 中的内容，并请求 ChatGPT/4 进行检查和总结。结果会作为评论发布回 PR。flow 函数是用Rust编写的，并在WasmEdge 运行时上在托管的flows.network中运行。

• 每次将新的提交推送到此 PR 时，都会自动更新代码检查评论。
• 当有人在 PR 的评论中说出一个魔法触发词时，可以触发新的代码检查。默认的触发词是"flows summarize"。

简单3步部署自己的代码检查机器人

1. 从模板创建一个机器人
2. 添加你的 OpenAI API密钥
3. 配置机器人以检查指定 GitHub repo 上的PR

0 前期准备

需要使用自己的 OpenAI API 密钥。如果还没有注册，请在此处注册。

还需要使用 GitHub 帐户登录 flows.network。这是免费的。

1 从模板创建机器人

单击此处

请检查 trigger_phrase 变量。这是你在 PR 评论中手动召唤检查机器人的魔法词。

单击 Create and Build 按钮。

2 添加你的 OpenAI API 密钥

现在你将设置 OpenAI integration。单击连接，输入您的密钥并为其命名。

完成后关闭选项卡并返回 flow.network 页面。 点击继续。

让我们看一个示例。你想要部署机器人从而总结 WasmEdge/wasmedge_hyper_demo repo 中的 PR。这里 github_owner = WasmEdge，github_repo = wasmedge_hyper_demo。

单击“创建和部署（Create and deploy）”按钮。

3 配置机器人以访问 GitHub

接下来，你需要告诉机器人它需要监控哪个 GitHub repo 以查看即将到来的 PR 进行检查。

• github_owner: 你想要为 repo 部署 🤖 的 GitHub org
• github_repo : 你想部署 🤖 的 GitHub repo

让我们看一个例子。您想要部署机器人来检查WasmEdge/wasmedge_hyper_demo repo 中的PR代码。这里 github_owner = WasmEdge 且 github_repo = wasmedge_hyper_demo。

点击 Connect 或 + Add new authentication 按钮，以使函数可以访问 GitHub repo 并部署🤖️。你将被重定向到一个新页面，在此页面须授予 flows.network 对该 repo 的权限。

完成后请关闭标签页并返回 flow.network 页面。点击 Deploy.

这就好了！你现在处在 flow 详细信息页面，正在等待 flow 函数构建。一旦 flow 状态变为 运行中，机器人就准备好进行代码检查了！每个新PR、每个新提交以及PR评论中的魔法词（即trigger_phrase），都会召唤机器人。

常见问题解答

自定义机器人

机器人的源代码可在你从模板克隆的 GitHub repo 中找到。请根据自己的需求任意更改源代码（例如，模型、上下文长度、API 密钥和提示）。如果需要帮助，请在 Discord 中询问！

使用 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 函数 repo 部署为多个机器人的源代码。当更新 repo 中的源代码并将其推送到 GitHub 时，会更改所有机器人的行为。

定制自己的魔法词

进入机器人正在运行的 flow 函数的 "Settings" 选项卡，你可以更新 trigger_phrase 配置。该配置的值是让用户触发机器人的魔法词，可以从 PR 评论触发检查。

鸣谢

此 flow 函数最初由 Jay Chen 创建，jinser 为优化来自 GitHub 的事件触发器做出了重大贡献。