提交信息与自动链接

默认情况下,当将内容从 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} 合并时变更请求的主题,或 无主题 如果未提供主题。

默认模板为:

最后更新于

这有帮助吗?