GitHub 拉取请求预览

在 GitHub 中创建拉取请求时预览你的内容

当你向已同步到 GitBook 空间的 GitHub 分支提交拉取请求（PR）时，你可以在合并前预览内容。这让你能够在合并更改之前检查其影响。

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

如何访问预览链接

只要你已经授予 GitBook GitHub 应用 对 PR 所需的只读权限，此行为即可开箱即用。

对于使用与 GitBook 空间同步的目标分支创建的每个 PR，你都会在 PR 中看到一个带有唯一预览 URL 的状态。点击该 详情 状态中的链接会带你进入内容的预览 URL。随后，你可以在合并 PR 之前确保内容符合预期。

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

安全注意事项

出于安全原因，默认情况下，GitBook 目前不会为从你仓库的 fork 分支打开的 PR 生成预览。因为 PR 预览中的内容可以通过你的自有域名访问，无论是在 .gitbook.io 还是你的自定义域名下，用户都可能在你公开仓库的 fork 中生成恶意内容，并让其以你的名义提供访问。

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

常见问题

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

常见原因：

• 你的网站尚未发布。 PR 预览 URL 会从你已发布的文档网站提供服务（在 .gitbook.io 或你的自定义域名下）。

• 你的网站位于需要身份验证的访问之后。 发布在以下位置后，Git Sync PR 预览不可用 已认证访问.