连接 GitHub 仓库

Before Orbit can deploy anything from GitHub you install the Kapsule Orbit GitHub App on your GitHub account or organisation and choose which repositories it can see. This guide walks through the…

在 Orbit 从 GitHub 部署任何内容之前，您需要在 GitHub 账户或组织上安装 Kapsule Orbit GitHub App，并选择它可以访问的存储库。本指南将引导您完成安装、选择存储库、创建项目，以及处理预期出现但未出现的存储库。

开始前

您需要有权限在拥有该存储库的账户或组织上安装 GitHub App。在个人账户上这是自动的。在组织上，您需要是所有者，或者所有者需要从组织的设置中批准您的安装请求。

步骤 1：安装 Kapsule Orbit GitHub App

在 KPanel 中，点击左侧边栏中的 Orbit。
点击 New project。
将模式设置为 Import Git Repo。
在步骤 1 中，点击 Connect GitHub。

您将被发送到 GitHub 以安装 Kapsule Orbit 应用。GitHub 会询问在哪里安装（您的个人账户或组织），然后询问是授予 All repositories 还是 Only select repositories。

选择 Only select repositories 并仅勾选您计划部署的存储库。您可以稍后从 GitHub 添加更多存储库，而无需在 Orbit 中断开连接或重新创建任何内容，这样可以保持集成的影响范围较小。

完成后，GitHub 会将您发送回 KPanel。步骤 1 现在显示 Just connected，您的存储库将加载到步骤 2。

步骤 2：选择一个存储库

您可以访问的存储库显示为列表。点击您要部署的存储库上的 Select。私有存储库带有 Private 徽章；Orbit 可以部署公有和私有存储库。

选定后，存储库显示 Selected 徽章，Change 链接让您选择不同的存储库。

如果存储库缺失

Orbit 只能列出 GitHub App 可以看到的内容。如果您预期的存储库不在其中：

点击步骤 1 上的 Reconnect GitHub 重新运行安装流程，或直接打开 github.com/settings/installations。
打开 Kapsule Orbit 安装，在 Repository access 下添加缺失的存储库。
返回 KPanel。列表将刷新。

如果面板显示 No repos accessible，说明应用已安装但未被授予任何存储库。打开 GitHub App 设置并至少授予一个存储库的访问权限。

其他常见原因：

存储库属于您未安装应用的组织。在个人账户上安装应用不会覆盖组织存储库。
组织所有者尚未批准您的安装请求。在他们批准之前，应用存在但看不到任何内容。
存储库在您安装应用后被转移或重命名。重新运行安装流程以刷新 Orbit 可以看到的内容。

步骤 3：配置您的项目

选择存储库后，步骤 3 要求填写两个字段：

字段	作用
Project Name	KPanel 中的显示名称，例如 `my-app`
Deploy URL	`kaps.run` 下的子域，所以 `my-app` 变成 `my-app.kaps.run`

点击 Create project。Orbit 将克隆存储库，排队您的第一个构建，并将您带到项目概览页面，您可以在那里查看日志流。

Deploy URL slug 在创建时设置一次，之后无法更改。如果您稍后想要不同的公有地址，应附加自定义域而不是尝试重命名 slug。请参阅 Adding a Custom Domain to Your Project。

Orbit 自动设置的内容

创建项目为您设置了推送到部署的功能。无需手动配置 webhook：

推送到您的生产分支会排队进行生产部署。
如果启用了 Branch previews，推送到任何其他分支将在 branch-<branch-name>.kaps.run 构建一个隔离的预览。请参阅 Branch Preview Deployments in Orbit。
Pull request 活动会被跟踪，因此预览部署显示它所属的 PR 编号。
关闭或合并 pull request 会暂停其预览，存储空间将在约一天内回收。

在 GitHub Actions 上进行部署门控

如果您在 GitHub Actions 中运行测试，您可以让 Orbit 等待它们。在 Settings 中，然后 CI required checks，输入确切的 Actions 作业名称，以逗号分隔，例如 build,test,lint。所有命名的检查必须通过，推送触发的生产部署才能进行。CI 失败会自动取消 Orbit 部署。

这仅适用于生产分支。

重新连接或更改您的安装

要更改 Orbit 可以看到的存储库：

点击 Orbit，然后点击 New project。
在步骤 1 中，点击 Reconnect 重新运行 GitHub App 安装流程。

或在 github.com/settings/installations 直接管理安装。那里的更改将在 Orbit 下次列出您的存储库时被应用。

断开 GitHub 连接

在 New project 的步骤 1 中，点击 Disconnect。

断开连接会移除您的 Kapsule 账户和 GitHub 之间的链接。您的项目及其部署历史会保留，当前实时部署继续提供流量，但推送触发的部署会停止，直到您重新连接。Deploy hooks 继续工作，因为它们通过提供商连接获取分支头：如果连接消失，钩子调用会失败并显示错误，而不是部署过时代码。