提交消息与自动链接

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

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

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

如果你想在提交中自动将你的 GitBook 变更请求 ID(例如 GITBOOK-123)解析为链接,你可以通过启用 GitHub 的 自动链接引用 功能来实现。请参阅以下说明: GitHubarrow-up-right.

使用以下 URL 格式,其中 spaceId 对应于你空间的 URL:

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

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

自定义提交信息模板

在将 GitBook 与 单体仓库一起使用时,或者当你对提交信息有特定规范时;你可能希望自定义 GitBook 推送提交到 Git 时所使用的信息。

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

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

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

默认模板是:

最后更新于

这有帮助吗?