GitHub 拉取请求预览

在 GitHub 创建拉取请求时查看内容预览

当您向已与 GitBook 空间同步的 GitHub 分支提交拉取请求(PR)时,您可以在合并前预览内容。这使您能够在合并更改之前检查其影响。

您可以使用此功能在合并 PR 之前进行最后一层检查,从而在将更改合并到已同步分支之前,在非生产环境中查看这些更改。

如何访问预览链接

只要您已授予 GitBook GitHub 应用 对 PR 的必要只读权限,此功能即可开箱即用。

对于每个使用与 GitBook 空间同步的目标分支创建的 PR,您都会在 PR 上看到添加的状态以及唯一的预览 URL。单击 详细信息 状态上的链接将带您到内容的预览 URL。然后您可以在合并 PR 之前确认内容是否符合预期。

预览链接仅对具有 GitBook 帐户的用户可访问。

安全注意事项

出于安全原因,默认情况下 GitBook 目前不会为从您仓库的 fork 打开的 PR 生成预览。由于 PR 预览的内容会在您自己的域名下可访问,无论是在 .gitbook.io 还是您的自定义域名下,用户都可能在您公开仓库的 fork 中生成恶意内容并以您的名义进行发布。

我们允许用户通过 Git 同步设置中的一个选项显式配置此行为。

最后更新于

这有帮助吗?