连接 GitHub

Jamdesk 会在您推送到 GitHub 时自动部署您的文档。

屏幕截图显示的是英文界面。

安装 GitHub App

您首次登录时，Jamdesk 会提示您安装 Jamdesk GitHub App。该应用授予以下权限：

• 仓库访问：读取您的文档内容
• Webhooks：推送时触发构建
• 提交状态：在提交上显示构建状态

权限

Jamdesk GitHub App 请求以下权限：

连接仓库

docs/           # Docs in a subdirectory
packages/docs/  # Monorepo with docs package

随后项目仪表板会显示已关联的仓库和分支：

自动部署

您配置的分支每次推送都会触发构建：

git add .
git commit -m "Update API documentation"
git push origin main

构建通常在 30–90 秒内完成。您可以在仪表板或 GitHub 提交页面上查看状态。

更换仓库

要连接其他仓库：

1. 前往 Settings → Repository
2. 点击 Change Repository
3. 选择新的仓库和分支

管理 GitHub App 访问权限

控制 Jamdesk 可以访问哪些仓库：

1. 前往 github.com/settings/installations
2. 在列表中找到 Jamdesk
3. 点击 Configure
4. 在 "Repository access" 下，选择特定仓库或全部仓库

组织仓库

对于组织仓库，组织管理员必须批准 GitHub App 的安装：

1. 从您的 Jamdesk 仪表板发起安装请求
2. 管理员会在 GitHub 中收到通知
3. 批准后，组织仓库会出现在仓库选择器中

关联个人账户

在 User Settings 中关联您的个人 GitHub 账户，以确保构建归属准确：

1. 点击您的头像 → User Settings
2. 找到 GitHub Account 部分
3. 点击 Link GitHub Account

此关联与 GitHub App 相互独立，用于将您的提交归属到您本人。了解更多。

故障排除

找不到仓库

• 确认 GitHub App 已安装在该仓库上
• 对于组织仓库，确认管理员已批准访问权限
• 在仪表板中刷新仓库列表

GitHub 不断将你带回 Jamdesk 应用页面

您的公司很可能管理着您的 GitHub 账户。GitHub 不允许这类账户自行安装应用。请参阅 公司托管的 GitHub 账户 进行修复。

使用其他 Jamdesk 账户正在使用的 GitHub 账户

仓库列表会显示以下开头的消息：

Another Jamdesk account already uses this GitHub account.

这表示另一个 Jamdesk 账户的项目已在该 GitHub 账户上使用 Jamdesk GitHub App。通常是同事先设置了 Jamdesk，或者您登录了第二个 Jamdesk 账户。

要使用该账户的仓库：

1. 点击 Verify on GitHub。
2. 以有推送权限的 GitHub 用户身份登录。
3. 从列表中选择仓库。

列表仅显示您的 GitHub 用户有推送权限的仓库。验证有效期为一小时，因此请在验证后尽快选择仓库。如果 Jamdesk 提示 GitHub 未显示您可用的安装，请检查您是否以正确的 GitHub 用户登录，或请 GitHub 账户的所有者授予您该仓库的访问权限。

如需在同一项目中工作，请让项目所有者邀请您。

未触发构建

• 检查仓库设置中的 webhook 是否处于活动状态
• 确认您推送的是已配置的分支
• 在 GitHub 中查看 webhook 投递错误

权限被拒绝错误

• 在您的 GitHub 设置中重新授权 GitHub App
• 确认 Jamdesk App 可以访问该仓库

接下来做什么？