Pull Request 与 GitHub
Yi Code 通过自己的 GitHub App 读仓库,用你自己的 GitHub 授权发布。一个会话只开一个 Draft PR,而且要你确认之后才开。它从不合并。
连接 GitHub
- 在新任务页点「连接 GitHub」,已经连过的话点输入框下面的「管理 GitHub 仓库」。
- 在 GitHub 上选账号或组织,再选仓库。选「Only select repositories」,Agent 就只能碰你勾选的那些。
- 装好后 GitHub 会让你授权这个 App。
授权这一步是在核对归属。安装 ID 谁都可以拼进 URL 里,所以 Yi Code 会向 GitHub 确认你的 GitHub 账号到底能看到哪些安装,只有在其中的才会连上。这个请求绑定当前登录的用户和组织,很快过期,只能用一次。这一步不会保存你个人的 GitHub 令牌。
由此带来几条规则:
- 一个安装只属于一个 Yi Code 组织。连到第二个组织会被拒绝,提示 "This installation is already connected to another organization"。
- 在 GitHub 上卸载 App 后,Yi Code 会把这个安装标记为已移除。之后这些仓库上的轮次会失败,提示「GitHub 安装已失效,请重新连接。」,不收费。
- 用同一个 GitHub 账号重新安装,这些仓库上已有的会话可以继续。换一个 GitHub 账号,接管不了通过别的账号连接的仓库。
组织里任何成员都能连接 GitHub。连好之后,每个登录的成员都能看到组织各个安装下的仓库。
App 的权限
App 申请的是仓库元数据的读权限,以及代码内容和 Pull Request 的读写权限,范围只限你选的仓库。Yi Code 通过这个安装来:
- 列出仓库和分支,把分支解析成提交。
- 为每一轮拉取固定的提交。
读仓库用的是短期的安装令牌,只限一个仓库、一种用途。推送会话分支、开 Draft PR 用的是你自己的 GitHub 授权,见用你自己的 GitHub 账号发布。任何 GitHub 令牌都不会出现在仓库地址、命令参数、轮次快照、事件里,也不会进沙箱。
分支是固定的
会话开始时,你选的分支会解析成它当时的提交。会话的每一轮都从这个提交加上本会话的改动开始。PR 描述里会写明这个提交是固定的基线。
创建 Draft PR
满足下面几条才能发布:
- 会话是你发起的。
- 最新一轮是成功的 Code。
- 会话有改动。
- 你已经绑定了自己的 GitHub 账号,并且它对仓库有写权限。
在「会话面板」点「创建 Draft PR」,在「确认将已审阅的差异发布为 GitHub Draft PR?」里确认。Yi Code 接着会:
- 再确认一次你的 GitHub 账号对仓库有写权限。
- 拉取固定的提交,把会话的补丁打上去。
- 以 "Yi Code" 的名义提交,用你的 GitHub 授权推到分支
preworld/{thread_id},{thread_id}是会话 ID。 - 以你的身份从这个分支向你选的分支开一个 Draft PR,标题是「Yi Code:」加会话标题。
之后「查看 Draft PR」会链接到它。
更新 PR
追问一轮 Code 之后,按钮变成「更新 Draft PR」。更新是一个新提交,父提交是分支当前的最新提交,也就是普通的快进推送。不改写历史,不强推。分支内容已经一致时,什么都不推。
发布时网络断了,再点一次就行。Yi Code 会先找会话分支和它的 PR,恢复原来那个,不会再开第二个。
无法更新的情况
会话分支归这个会话所有。遇到下面的情况,Yi Code 会停下来,不会覆盖别人的工作。这些提示在界面上显示英文原文:
| 提示 | 发生了什么 | 怎么办 |
|---|---|---|
| "The PR branch has external changes; start a new session" | 有人在 Yi Code 之外往 preworld/… 分支推了提交。 | 开一个新会话。 |
| "The session PR is closed; start a new session" | PR 在 GitHub 上被关了。 | 开一个新会话。 |
| "The session branch was removed; start a new session" | 分支在 GitHub 上被删了。 | 开一个新会话。 |
不会替你合并
Yi Code 只创建 Draft PR,不会把它标成 ready,不会 approve,也不会合并。代码评审、CI 和合并都留给你们团队在 GitHub 上做。
谁能发布
通过 GitHub App 连接的仓库,任何成员都能发布自己的会话,前提是他自己的 GitHub 账号对仓库有写权限。谁都不能发布别人的会话,所有者也不行。管理员在「设置」里按地址添加的项目,只有所有者和管理员能发布,同样只能发布自己的会话。每次发布都会记进组织的审计日志,这一轮也会记下 Yi Code 用户、GitHub 账号、仓库、提交和 PR。
用你自己的 GitHub 账号发布
发布用的是你自己的 GitHub 授权,所以 PR 是你开的,GitHub 按你本人的权限处理。
- 打开「会话面板」,在「GitHub 发布身份」下点「绑定个人 GitHub」。
- 在 GitHub 上授权这个 App。回到 Yi Code 后,「会话面板」里会显示你的 GitHub 用户名。
面板上写着「发布前会检查此账号对仓库的写权限。」每次发布,Yi Code 都会先问 GitHub 你的账号能不能推送到这个仓库。不能的话,发布停止,提示「此 GitHub 账号没有目标仓库的写权限。」
- 一个 GitHub 账号只能绑定一个 Yi Code 用户。已经被别人绑定的账号,再绑会被拒绝。
- 授权加密保存,密钥只有 API 持有,按 GitHub 的要求自动刷新。它不会交给沙箱,也不会交给执行主机。
- 「断开个人 GitHub」会立即停止发布,并在 GitHub 上撤销授权。GitHub 没有确认撤销时,页面提示「发布权限已停止,GitHub 撤销授权仍待确认。」,并提供「重试断开 GitHub」和「在 GitHub 管理授权」。
- 「重新验证 GitHub」会重新绑定一次,比如你在 GitHub 上换了账号之后。
其他 Git 服务
只有 github.com 上的仓库能创建 Draft PR。用其他 Git 服务时(私有部署里可以这样做),从「原始日志与产物」里取 changes.patch。