GitHub 拉取请求预览

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

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

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

如何访问预览链接

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

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

circle-info

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

安全性注意事项

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

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

最后更新于

这有帮助吗?