提交信息与自动链接

默认情况下,当从 GitBook 导出内容到 Git 仓库时,GitBook 会基于已合并的变更请求生成提交信息:

GITBOOK-14:改进有关用户管理的文档

自动链接 GITBOOK-<num> 在 GitHub 和 GitLab 中

如果您想在提交中将 GitBook 变更请求 ID(例如)自动解析为链接, GITBOOK-123您可以使用 GitHub 的以下功能启用此项: 自动链接引用 功能。请参阅以下说明: GitHub.

使用下面的 URL 格式,其中 spaceId 对应您空间的 URL:

<https://app.gitbook.com/s/{spaceId}/~/changes/<num>/

A GitBook screenshot showing autolink setup
自动链接设置。

自定义提交信息模板

在将 GitBook 与 单体仓库(monorepo)一起使用,或者当您对提交信息有特定指南时,您可能希望自定义 GitBook 在推送提交到 Git 时使用的消息。

模板可以包含以下占位符:

  • {change_request_number} 变更请求的唯一数字 ID

  • {change_request_subject} 合并时变更请求的主题,或 无主题 如果未提供主题。

默认模板为:

GITBOOK-{change_request_number}:{change_request_subject}

最后更新于

这有帮助吗?