heydeer
参考

GitHub App 与权限

HeyDeer 通过安装在你的个人账号或组织上的 GitHub App 工作。你可以选择 HeyDeer 能读取和审查哪些仓库。

安装 HeyDeer

每个工作区属于一个 GitHub 账号:个人账号或组织。

  1. 选择在 GitHub 上安装或安装到其他账号。首次设置时,它位于连接你的仓库下。之后如需连接其他账号,请先在工作区菜单中选择添加工作区。
  2. 在 GitHub 上选择账号,然后选择 HeyDeer 可以审查的仓库。
  3. 在 GitHub 上确认。随后 HeyDeer 会打开该账号的工作区。

在组织中,只有所有者才能安装 GitHub App;其他人安装时,GitHub 会向所有者发送请求。请求待处理期间,HeyDeer 会显示正在等待 GitHub 所有者批准,工作区管理员此时已经可以配置设置。

所有者批准后,工作区会自动连接,HeyDeer 会向工作区通知邮箱发送邮件。

添加仓库

在 GitHub 上选择 Only select repositories(仅选择部分仓库),并挑选要审查的仓库。All repositories(所有仓库)还会包括之后新建的仓库。

之后如需添加仓库,请在仓库页面选择添加仓库,或在工作区设置 → GitHub 连接中选择管理 GitHub 访问权限。只有该 GitHub 账号的所有者才能在 GitHub 上保存更改。其他人会看到向团队求助,其中有一份可复制并发送给所有者的请求。

新添加的仓库沿用审查规则中的工作区默认设置。只有当某人和 HeyDeer 在 GitHub 上都能访问某个仓库时,此人才能在 HeyDeer 中看到该仓库及其审查。发起审查需要写权限;参见 PR 评论命令。

权限

权限访问级别HeyDeer 用它做什么
Contents读写读取代码和历史记录,将 HeyDeer 自己发起的审查讨论标记为已解决,并为修复和 @heydeer 请求推送分支和提交。
Pull requests读写读取 PR,发布审查、评论和回复,并按你的要求创建、更新和合并 PR。
Workflows读写当修复或请求需要修改 GitHub Actions 工作流文件时进行更新。
Checks读写显示 HeyDeer Review 检查,并接收其按钮发出的请求。
Actions只读读取失败的 GitHub Actions 作业日志,让 Autopilot 能修复这些失败。
Issues读写接收 @heydeer 提及和命令,通过表情回应确认收到,读取相关 Issue,并按你的要求创建和更新 Issue。
Metadata只读读取仓库基本信息以及谁拥有写权限。
Members(组织)只读列出工作区成员,并检查自动审查筛选条件和手动审查权限中的成员和团队条件。
Email addresses(账号)只读把你已验证的邮箱推荐为通知邮箱。

如果 GitHub 尚未授予 HeyDeer 所需的权限,工作区设置 → GitHub 连接会显示需要 GitHub 权限或可授予更多 GitHub 权限。由该 GitHub 账号的所有者选择查看权限请求,并在 GitHub 上接受。

如需了解 HeyDeer 如何处理你的代码和数据,参见安全和数据处理。

找不到账号或仓库时

只有装上 HeyDeer 的组织才会在连接时列出。要添加组织,请选择在 GitHub 上安装或安装到其他账号,然后在 GitHub 上选择它;如果你不是所有者,GitHub 会向所有者发送请求。如果已装 HeyDeer 的组织仍未列出,请在 GitHub 上通过 SSO 登录该组织,然后展开找不到你的账号?,选择重新登录 GitHub。

如果所有者批准你的请求时该组织还没有工作区,HeyDeer 会创建工作区,并将你设为管理员。

如果 HeyDeer 显示恢复仓库访问权限,说明你的 GitHub 账号无法访问已授权给 HeyDeer 的仓库。请选择更新 GitHub 授权。其他情况参见故障排除。

HeyDeer 的 GitHub 访问权限被暂停或移除时

如果 HeyDeer 在 GitHub 上被暂停,工作区设置 → GitHub 连接会显示 GitHub 访问已暂停,审查将无法运行。由该 GitHub 账号的所有者选择恢复 GitHub 访问。

如果 HeyDeer 被卸载,会显示 HeyDeer 已从 GitHub 卸载。由所有者选择重新安装 HeyDeer;工作区会保留其设置和审查记录。