连接 GitHub
将 GitHub 仓库连接到 Jamdesk，实现推送自动部署，并配置应用、仓库和分支。
Jamdesk 集成 GitHub，可在你推送更改时自动部署文档。
屏幕截图显示的是英文界面。
有关 GitHub App 与个人账户关联如何协同工作的背景信息，请参阅 了解 GitHub 集成。
使用 Bitbucket Cloud 管理文档？请参阅连接 Bitbucket。每个项目只能连接一个提供商。
安装 GitHub App
首次登录 Jamdesk 时，系统会提示你安装 Jamdesk GitHub App。此应用支持：
- 仓库访问权限 - 读取文档内容
- Webhooks - 在推送时触发构建
- 提交状态 - 显示提交的构建状态
权限
Jamdesk GitHub App 请求以下权限：
| 权限 | 用途 |
|---|---|
| 仓库内容（读取） | 克隆并读取文档文件 |
| 元数据（读取） | 列出仓库和分支 |
| Webhooks | 接收推送通知 |
Jamdesk 只会访问你明确授予访问权限的仓库。你可以随时在 GitHub 设置中修改访问权限。
连接仓库
创建或编辑项目时，点击 Connect Repository。
从已安装 GitHub App 的仓库中进行选择。
选择要部署的分支：
- main 或 master - 生产文档最常用
- docs - 如果你将文档保存在单独的分支中
- 任意分支 - 用于预览部署
如果 docs.json 不在仓库根目录中，请指定路径：
docs/ # Docs in a subdirectory
packages/docs/ # Monorepo with docs package如果 docs.json 位于根目录中，请留空。
连接后，项目仪表板会显示已关联的仓库和分支：
自动部署
连接后，向已配置分支的每次推送都会触发构建：
git add .
git commit -m "Update API documentation"
git push origin main构建通常需要 30–90 秒完成。你可以在仪表板或 GitHub 提交中查看状态。
更换仓库
如需连接其他仓库：
- 前往 Settings → Repository
- 点击 Change Repository
- 选择新的仓库和分支
更换仓库可能会影响线上文档。新仓库必须包含有效的 Jamdesk 配置。
管理 GitHub App 访问权限
控制 Jamdesk 可以访问哪些仓库：
- 前往 github.com/settings/installations
- 在列表中找到 Jamdesk
- 点击 Configure
- 在“Repository access”下，选择特定仓库或全部仓库
组织仓库
对于组织仓库，组织管理员必须批准 GitHub App 的安装：
- 从 Jamdesk 仪表板请求安装
- 管理员会在 GitHub 中收到通知
- 批准后，组织仓库会显示在仓库选择器中
关联个人账户
为确保构建归属准确，请在 User Settings 中关联你的个人 GitHub 账户：
- 点击你的头像 → User Settings
- 找到 GitHub Account 部分
- 点击 Link GitHub Account
这与 GitHub App 相互独立，可确保你的提交正确归属于你。了解更多。
故障排除
找不到仓库
- 确认仓库已安装 GitHub App
- 对于组织仓库，确认管理员已批准访问权限
- 尝试在仪表板中刷新仓库列表
GitHub 不断将你带回 Jamdesk 应用页面
你的公司可能管理着你的 GitHub 账户，而 GitHub 不允许此类账户在自己的账户上安装应用。请参阅公司管理的 GitHub 账户进行修复。
未触发构建
- 检查仓库设置中的 Webhook 是否处于启用状态
- 确认你推送到了已配置的分支
- 在 GitHub 中查找 Webhook 传送错误
权限被拒绝错误
- 在 GitHub 设置中重新授权 GitHub App
- 确保 Jamdesk App 可以访问该仓库
如需更详细的故障排除信息，请参阅了解 GitHub 集成。