内容提要
本文介绍如何将自托管Forgejo仓库连接到Read the Docs,实现提交自动触发文档构建。步骤包括:在Read the Docs中删除GitHub集成,手动配置仓库URL,添加GitHub类型webhook;在Forgejo中设置webhook,填入URL和密钥,触发推送事件;最后清理GitHub旧webhook。
延伸解读
手动集成的原理
Read the Docs 目前不支持 Forgejo 作为官方集成,但 Forgejo 的 webhook 格式与 GitHub 相似,因此可以“欺骗”Read the Docs 将其视为 GitHub 集成。通过手动配置仓库 URL 和添加 GitHub 类型的 webhook,实现提交后自动触发文档构建。
迁移注意事项
迁移前需在 Read the Docs 中删除原有的 GitHub 集成,否则旧 webhook 可能继续触发构建。同时,在 Forgejo 中配置 webhook 时,需确保 HTTP 方法为 POST,触发事件为 Push,并正确填写 URL 和密钥。
清理旧集成
迁移完成后,建议删除 GitHub 仓库中指向 readthedocs.org 的旧 webhook,避免冗余和潜在冲突。虽然此步骤非必需,但有助于保持仓库整洁,防止误触发。
Q&A
如何将自托管的Forgejo仓库连接到Read the Docs?
在Read the Docs中删除GitHub集成,手动配置仓库URL,添加GitHub类型的webhook;在Forgejo中设置webhook,填入URL和密钥,触发推送事件;最后清理GitHub旧webhook。
Read the Docs是否原生支持Forgejo集成?
目前不支持,需要手动配置,通过模拟GitHub webhook来实现。
在Read the Docs中如何删除旧的GitHub集成?
登录Read the Docs,进入项目设置,选择“Integrations”,找到“GitHub incoming webhook”,点击右侧的垃圾桶图标删除。
在Read the Docs中如何手动配置仓库URL?
在项目设置中,勾选“Use manually configured repository URL”,然后在“Repository URL”字段输入仓库URL,保存即可。
在Forgejo中如何添加webhook以触发文档构建?
在Forgejo仓库设置中,选择“Webhooks”,点击“Add webhook”,选择“Forgejo”类型,填入Read the Docs提供的URL和密钥,设置HTTP方法为POST,触发事件为Push events,保存即可。
为什么Read the Docs会显示不支持的警告?
因为Forgejo不是Read the Docs官方支持的集成类型,但Forgejo的webhook格式与GitHub类似,所以可以正常工作。
是否需要清理GitHub上的旧webhook?
不是必须的,但为了整洁,建议删除GitHub仓库中指向readthedocs.org的webhook,因为它在Read the Docs侧删除集成后已失效。