回迁更改
带有版本化文档的项目通常会在多个长期分支中维护每个版本的代码和文档。main
分支包含最新的代码和文档。
项目发布通常使用包含主要和次要版本号的长期分支。例如,在 grafana/grafana
仓库中,v9.0.x
长期发布分支包含 Grafana 主要版本 9
和次要版本 0
的所有补丁版本的代码和文档。
回迁(Backporting)是指将 main
分支中的更改移植回另一个长期发布分支。
对带有版本化文档的项目提交的每个文档拉取请求,都需要决定是否回迁。
您应该将更改回迁到受拉取请求更改影响的项目的所有受支持版本。
如果您不确定,请在拉取请求中向维护者寻求建议。
开始之前
- 要回迁更改,仓库必须安装回迁工作流程。要安装回迁工作流程,请参阅 安装回迁工作流程。
回迁更改
要回迁更改,请添加相应的 backport <BRANCH>
标签。您可以使用多个标签回迁到多个分支。
对于已合并的拉取请求,Grafana 机器人 Grot 会为每个 backport <BRANCH>
标签创建后续拉取请求。您可以在合并拉取请求之前或之后添加 backport <BRANCH>
标签。如果 Grot 无法自动回迁更改,它会在原始拉取请求上评论并提供手动回迁更改的说明。
在 grafana/grafana
等仓库中,工程师有时会在发布之前很久就为一个版本创建分支。如果您打算针对即将发布的版本发布内容,请在合并拉取请求之前检查是否有即将发布的版本的回迁标签。如果存在,请应用该标签,以确保内容被自动回迁到即将发布的版本的文档中。
如果您决定 *不* 回迁更改,则无需添加任何标签。
何时回迁
本指南为一般性指南。有关 grafana/grafana
的具体指南,请参阅 何时以及回迁什么到 grafana/grafana
。
更改类型 | 版本 |
---|---|
拼写错误 | “最新”版本 |
文案编辑 | “最新”版本 |
架构更改 | “最新”版本 |
不正确的信息 | 支持的版本 |
即将发布的版本中的新内容 | 即将发布的版本 |
即将发布的版本之后的新内容 | 即将发布的版本 |
何时以及回迁什么到 grafana/grafana
本节专门针对 grafana/grafana
仓库的回迁指南进行概述。
后面的表格概述了
- 您是否必须回迁更改
- 回迁到哪些版本
但是,版本分支是否已创建会改变这一决定。
新版本分支创建之前
这是“最新版本”发布日期与即将发布的版本分支创建日期之间的时间段。例如:
- Grafana v11.2 于 2024 年 8 月 27 日发布
- Grafana v11.3 版本分支于 2024 年 10 月 8 日创建
8 月 24 日至 10 月 8 日是新版本分支创建之前的时间段。
这是最常见的情况。
新版本分支创建之后但 *发布之前*
这是发布前大约最后两周的时间段。在此期间,为即将发布的版本准备的内容需要回迁。例如:
- Grafana v11.3 版本分支于 2024 年 10 月 8 日创建
- Grafana v11.3 于 2024 年 10 月 22 日发布
从 10 月 8 日到 22 日,新版本分支已创建但尚未发布。
指南
更改类型 | 版本分支创建之前 | 版本分支创建之后 |
---|---|---|
拼写错误 | “最新”版本 | “最新”版本 + 即将发布的版本 |
文案编辑 | “最新”版本 | “最新”版本 + 即将发布的版本 |
架构更改 | “最新”版本 | “最新”版本 + 即将发布的版本 |
不正确的信息 | 支持的版本 | 支持的版本 + 即将发布的版本 |
即将发布的版本中的新内容 | 即将发布的版本 | 即将发布的版本 |
即将发布的版本之后的新内容 | 即将发布的版本 | 即将发布的版本 |
如果您想回迁的内容超出了本指南范围,由您自行决定。本表格概述了最低标准。
回迁教程
根据网站挂载教程内容的位置,您可能需要回迁对教程的更改。
对于 grafana/grafana
,网站从文档的 next
版本挂载教程内容,因此您无需回迁更改。
对于其他仓库,请回迁到与网站上文档版本对应的分支。