Skip to content

docs/release: add mainline versioning and release process documentation - #11955

Open
kurisaW wants to merge 1 commit into
RT-Thread:masterfrom
kurisaW:ver-def
Open

kurisaW wants to merge 1 commit into
RT-Thread:masterfrom
kurisaW:ver-def

Conversation

@kurisaW

@kurisaW kurisaW commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

拉取/合并请求描述:(PR description)

[

实行路径:#11956

为什么提交这份PR (why to submit this PR)

补充 RT-Thread 主线版本编号规则和版本发布流程,帮助维护者及社区开发者明确版本分类、发布节奏、兼容性要求和发布职责

你的解决方案是什么 (what is your solution)

  • 新增版本编号制定与实施细则、版本发布流程的文档。
  • 明确 X/Y/Z 版本判定规则,统一 Y 版本周期为 3~6 个月、Z 版本周期为 1 个月,并同步相关规划和发布节奏表述。

请提供验证的bsp和config (provide the config and bsp)

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用clang-format 源码格式化工具确保格式符合RT-Thread代码规范 This PR has been formatted with clang-format and complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • Use workflow from 保持默认分支(通常为 master)
    Keep the default branch (usually master) in Use workflow from
  • 在 branch 输入框填写 PR 分支 ver-def
    Enter PR branch ver-def in the branch field
  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将作为独立提交推送至你的分支。
    The formatting changes will be pushed to your branch as a separate commit.

完成后,提交将自动更新至 ver-def 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the ver-def branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions github-actions Bot added the Doc This PR/issue related with documents label Oct 30, 2026
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: documentation

Reviewers: @CXSforHPU @GorrayLi @lianux-mm

Changed Files (Click to expand)
  • documentation/7.contribution/INDEX.md
  • documentation/7.contribution/figures/release_process_overview_cn.png
  • documentation/7.contribution/figures/release_process_stage_1_cn.png
  • documentation/7.contribution/figures/release_process_stage_2_cn.png
  • documentation/7.contribution/figures/release_process_stage_3_cn.png
  • documentation/7.contribution/figures/release_process_stage_4_cn.png
  • documentation/7.contribution/figures/release_process_stage_5_cn.png
  • documentation/7.contribution/figures/release_process_stage_6_cn.png
  • documentation/7.contribution/release_process_cn.md
  • documentation/7.contribution/release_process_en.md
  • documentation/7.contribution/release_versioning_cn.md
  • documentation/7.contribution/release_versioning_en.md
  • documentation/Doxyfile.1.9.1
  • documentation/Doxyfile.1.9.8

📊 Current Review Status (Last Updated: 2026-11-03 15:57 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@BernardXiong BernardXiong added the +1 Agree +1 label Nov 2, 2026
@Rbb666

Rbb666 commented Nov 3, 2026

Copy link
Copy Markdown
Member

@kurisaW

ci有个文档报错:

image

@kurisaW
kurisaW force-pushed the ver-def branch 2 times, most recently from a29e6d1 to 316dad0 Compare November 3, 2026 06:30

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc This PR/issue related with documents +1 Agree +1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants