GitHub 拉取请求预览

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

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

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

如何访问预览链接

此行为开箱即用,前提是您已授予 GitBook GitHub 应用arrow-up-right 对 PR 的必要只读权限。

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

circle-info

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

安全注意事项

出于安全原因,默认情况下 GitBook 当前不会为从您仓库的分叉中打开的 PR 生成预览。因为 PR 预览的内容可在您自己的域名下访问,无论是在 .gitbook.io 还是您的自定义域名上,用户都可能在您公开仓库的分叉中生成恶意内容并以您的名义提供服务。

我们允许用户通过 Git 同步设置中的一个选项明确配置此项。

常见问题

为什么我在拉取请求中看不到我的 GitBook 文档的预览?

常见原因:

  • 您的站点未发布。 PR 预览 URL 是从您已发布的文档站点(在 .gitbook.io 或您的自定义域名上)提供的。

  • 您的站点受身份验证访问保护。 Git 同步 PR 预览不适用于发布在 身份验证访问保护后的站点.

最后更新于

这有帮助吗?