变更请求

通过变更请求协作进行内容编辑

变更请求是您主内容的副本。它来自于“分支”的简单概念, 分支,对于使用 GitHub 的 pull request 或 GitLab 的 merge request 的人来说会感觉熟悉。

在变更请求中,您可以编辑、更新和删除内容元素,请求对更改进行审查,然后将它们合并回主版本以应用您所做的所有更改。

A GitBook screenshot showing the change requests panel
通过变更请求编辑您的内容。

创建变更请求

在禁用实时编辑的空间内,点击 编辑 按钮位于 空间标题 中以开始新的变更请求。

这将打开一个新的变更请求,您可以根据需要编辑或删除内容。您的更改会自动保存,其他人也可以加入您的变更请求以实时协作。

一旦您对更改感到满意,您可以使用标题栏中的按钮来 请求审查 您的变更请求,或 合并 它直接进入主分支。

预览变更请求

您可以通过点击 预览 选项位于 空间标题来预览您在变更请求中所做的更改。这将切换到包含所提议更改的已发布文档预览,便于您在整个已发布文档的上下文中查看更改。

预览 按钮下方有一个站点预览的 URL。点击它,您的站点预览会在新标签页中完整打开。

当您在新标签页中打开预览 URL 时,您还会看到 预览工具栏 位于浏览器窗口底部。该工具栏可让您快速跳回 GitBook 以查看、编辑或评论变更请求,或打开站点的实时版本。

您只能预览已添加到 已发布文档站点.

请求对变更请求进行审查

当您希望团队成员在将更改合并到主分支之前检查您的内容时,请对您的变更请求请求审查。

您可以为变更请求添加描述以向审阅者提供背景,并标记您希望检查您工作的特定人员。

当您点击 请求审查时,变更请求的状态将更改为 正在审查中,并且您在审查请求中标记的任何人都会收到通知。

如果您的更改不需要审查,您可以直接将更改合并到主版本。

如果您在审查请求中未标记任何人,具有审阅者权限的所有人都会收到有关您请求的通知。如果空间中没有审阅者,则会通知审阅者之上的下一个角色。

审查变更请求

如果您收到审查变更请求的请求,您可以编辑内容并留下反馈,以确保在合并到主版本之前它处于良好状态。您可以在认为仍需修改时请求更改,或者批准变更请求以表示它已准备好合并。

大多数审查将在变更请求的 评论中进行,协作者可以在其中共享反馈并就特定内容块或整个变更请求进行讨论。

差异视图

当您打开空间标题中的 更改 选项卡时,差异视图会出现。差异视图会突出显示在变更请求中被编辑的每个页面和块。它会在目录中突出显示任何被编辑的页面,并在页面上显示已添加、编辑或删除的具体块。

在使用差异视图时有两个选项:

  1. 显示所有页面 — 这是差异视图的默认模式,它会在目录中显示已修改和未修改的页面。这有助于在整个空间的上下文中查看哪些页面已被编辑。

  2. 仅显示已更改的页面 — 该模式只会在目录中显示已修改的页面,帮助您集中查看被更改的内容。在包含许多页面和子页面的大型空间中尤其有用。

您可以切换到 更改 选项卡以检查任何变更请求的差异视图。

合并变更请求

合并变更请求会将变更请求的更改添加到内容的主分支中,创建已更新的版本并在空间的 版本历史记录.

中生成新条目。

安排合并 如果您希望在计划的时间合并变更请求——例如与产品发布周期对齐——您可以通过.

GitBook 的 API

使用外部工具(如 GitHub Actions)或通过 Zapier 等自动化平台连接来实现。
例如,添加以下 GitHub 工作流会每周合并一次变更请求:

.github/workflows/scheduled-gitbook-merge.yml
  name: Scheduled GitBook Merge
    on:

schedule:
  - cron: '0 9 * * 3'  # 每周三 09:00 UTC 运行
    jobs:
    merge_changes:
      runs-on: ubuntu-latest
        steps:
          - name: Merge Change Request
          run: |
          curl -X POST https://api.gitbook.com/v1/spaces/{space-id}/change-requests/{change-request-id}/merge \

-H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' 只有

管理员、创建者和审阅者

可以合并变更请求。

处理合并冲突

有时,当您想合并变更请求时,您可能会发现主内容与您要合并的内容之间存在冲突。最简单的形式下,冲突是无法自动合并的内容片段。

如果发生这种情况,系统会向您显示冲突警报,并列出您在继续合并之前需要解决的冲突。 解决合并冲突 在解决合并冲突时,您有两种选择—— 选择要合并的版本 .

手动

编辑内容

选择要合并的版本

您可以通过选择要合并的版本来解决合并冲突——要么是您传入的内容,要么是之前存在的内容。这使您可以在两个更改之间进行选择——要么是您最近的工作,要么是原始内容。

如果您遇到可以通过这种方式解决的合并冲突,您可以选择要保留的版本,另一个版本将被删除。

手动编辑

如果您不想在版本之间做选择,您可以通过手动编辑冲突来解决合并冲突。您可以删除不需要的块,甚至完全重写它们。满意更改后,您可以继续下一个冲突,直到全部解决。

归档变更请求 如果您决定不合并某个变更请求并希望将其从队列中移除,您可以将其归档。 The Actions menu icon in GitBook 要归档变更请求,首先打开它。然后点击变更请求标题旁的 操作菜单并选择 归档 。您可以稍后通过打开 变更请求 菜单并选择

最后更新于

这有帮助吗?