安装
第一次登录后,Orbi 会显示「连接仓库」页,上面写着「还没有安装 Orbi 的 GitHub App。」。App 装好之前,打开状态页或连接页看到的都是这一页。页面上说明了安装前要知道的几件事:安装不收费,Orbi 只能改你选的 GitHub 仓库;展开「全部权限」能看到完整的权限说明。点「安装 Orbi 的 GitHub App」,就会被送到 GitHub 的安装页。 在 GitHub 的安装页上:- 选中拥有目标仓库的账号或组织。
- 选 Only select repositories。
- 只勾要交给 Orbi 的那个仓库,点 Install。试用 Orbi 有一个小仓库就够了,以后可以再往安装里加。
- 「找不到您的仓库?」:仓库在组织下的话,先在 GitHub 安装页选这个组织。按钮变成 Install and request 或 Request,说明要组织管理员批准。
- 「GitHub 上还没有仓库?」:点「用 Orbi 的示例新建一个仓库」,先建一个仓库再回来安装。经核实的官方示例副本不占仓库名额,也不占免费交付次数;每个账户最多连一个,见示例体验。
装在组织上会为这个组织创建一个独立的 Orbi 租户,有自己的订阅和用量。装在你的个人账号上则创建一个个人租户。两者不共享。
这些权限各是干什么的
批准之前 GitHub 会把完整的权限清单摊给你看。Orbi 的安装页上「全部权限」的说明是:在你选的 GitHub 仓库里,可读写代码、Issue、PR、GitHub Actions 工作流和 Actions 变量;可读仓库设置、检查结果和 Actions 运行记录;不能修改仓库设置;另外可读您的 GitHub 邮箱。每一项的用途如下:
这些权限就是让一个 agent 干你要它干的活所需要的:在分支上写代码、提交拉取请求、检查之后合并。如果你的组织策略不允许授予拉取请求和仓库内容的写权限,Orbi Cloud 就没法往那个仓库里交付。
修改覆盖哪些仓库
App 的安装决定 Orbi 能看到哪些仓库;连接仓库决定它在哪些仓库里干活。同一时间能连接几个仓库取决于你的套餐,见额度与限制。如果连接页上没有出现你的目标仓库,说明安装 App 时没把它包进来。 要修这个问题,展开连接页上的「列表里没有您的仓库?」,点里面的「GitHub App 设置」链接,在 Repository access 里把仓库加进去,点 Save。GitHub 改完不会自动跳回 Orbi,回到 Orbi Cloud 刷新连接页就行。撤销
你随时可以在 GitHub 上卸载 Orbi GitHub App:在 GitHub 的 Settings → Applications → Installed GitHub Apps 里找到 Orbi,点 Configure,再选 Uninstall(组织的话,在组织设置下走同样的路径)。 卸载会立即收回 Orbi 对你代码的访问权限。状态页会检测到这件事,标题变成「Orbi 卡住了,需要您看一下」,下面写着「Orbi 的 GitHub App 已被卸载」,并提供「重新安装 GitHub App」按钮。卸载 App 不会取消订阅。订阅要单独在付费里取消。