docs/release: add mainline versioning and release process documentation
No files matched your search
@@ -11,3 +11,8 @@ All the real-time operating system kernel and open source components can be used
|
||||
@subpage page_bsp_contribution_guide_en
|
||||
|
||||
@subpage page_howto_doxygen
|
||||
|
||||
@subpage page_release_versioning_en
|
||||
|
||||
@subpage page_release_process_en
|
||||
|
||||
|
After Width: | Height: | Size: 387 KiB |
|
After Width: | Height: | Size: 57 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 50 KiB |
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 75 KiB |
@@ -0,0 +1,120 @@
|
||||
# RT-Thread 版本发布流程
|
||||
|
||||
[English](release_process_en.md) | [版本编号制定与实施细则](release_versioning_cn.md)
|
||||
|
||||
本文描述 RT-Thread 主线版本从需求准备到正式发布的六个阶段。版本号判定、兼容性要求和发布检查参见[版本编号制定与实施细则](release_versioning_cn.md)。
|
||||
|
||||
## 阶段一:版本准备工作
|
||||
|
||||
### 1. 首要目标
|
||||
|
||||
- 确定本版本最终的开发任务,并生成版本开发任务视图。
|
||||
|
||||
### 2. 主要内容
|
||||
|
||||
#### 重点内容
|
||||
|
||||
- 版本草案整理:整理上一个版本的完成度文档,并结合上一版本的版本开发草案,制定本次版本的初步计划。
|
||||
- GitHub Issue 整理:整理历史版本遗留问题 Issue,收集版本新特性 Issue,并使用版本 Label 标记。
|
||||
|
||||
#### 其他内容
|
||||
|
||||
- 其他部门需求汇总:收集其他部门的功能性需求,整理成需求文档。
|
||||
- 前沿技术:评估市面上的新技术,考虑是否移植到主线,以 Issue 或 Discussions 形式记录。
|
||||
- 竞品分析:对比同类产品性能差异,分析可引入的特性,以 Issue 或 Discussions 形式记录。
|
||||
|
||||

|
||||
|
||||
## 阶段二:制定下个版本的初步目标
|
||||
|
||||
### 1. 首要目标
|
||||
|
||||
- 确定下个版本的初步任务。
|
||||
|
||||
### 2. 主要内容
|
||||
|
||||
1. 从上一版本发布后开始收集社区需求反馈,整理成 Issue。
|
||||
2. 根据 Issue 汇总成 Milestone。
|
||||
3. 制定下一版本的初步目标。
|
||||
|
||||

|
||||
|
||||
## 阶段三:版本开发准备阶段
|
||||
|
||||
### 1. 首要目标
|
||||
|
||||
- 根据版本开发任务视图分配开发人员任务。
|
||||
|
||||
### 2. 主要内容
|
||||
|
||||
- 为本次版本的开发任务分配开发人员。
|
||||
- 指派审查人员对不同特性的 PR 进行审查。
|
||||
|
||||

|
||||
|
||||
## 阶段四:版本开发阶段
|
||||
|
||||
### 1. 首要目标
|
||||
|
||||
- 跟踪完成情况,提前通知冻结特性。
|
||||
|
||||
### 2. 主要内容
|
||||
|
||||
- 完成版本开发目标,并在版本计划中记录进度。
|
||||
- 对核心 PR,在发布前半个月通知冻结特性。
|
||||
- 使用 GitHub Label 标记社区开发者提出的新特性 PR。
|
||||
- 处理常规 PR,这部分可贯穿版本开发。
|
||||
|
||||

|
||||
|
||||
## 阶段五:预发布阶段
|
||||
|
||||
### 1. 首要目标
|
||||
|
||||
- 完成特性收敛和 BUG 回归工作。
|
||||
|
||||
### 2. 主要内容
|
||||
|
||||
#### 核心工作
|
||||
|
||||
- 完成特性收敛工作,推动作者完成新特性 PR 的合并。
|
||||
- 完成 BUG 回归工作,收集社区反馈的版本问题,包括开发版本及发布版本。
|
||||
|
||||
#### 测试工作
|
||||
|
||||
- 结合版本测试用例模板,对不同架构、BSP、内核、组件、外设、文件系统等内容进行测试并记录问题。参考[上一版本的测试用例文档](https://docs.qq.com/sheet/DYUFZbEdrek1KWFd4)。
|
||||
|
||||
#### 总结工作
|
||||
|
||||
- 汇总版本开发任务进度和社区开发者新特性 PR,形成版本任务完成度文档。
|
||||
|
||||

|
||||
|
||||
## 阶段六:版本发布
|
||||
|
||||
### 1. 重点工作
|
||||
|
||||
- 在 GitHub 发布版本 Tag 及 Release。
|
||||
- 在 Gitee 发布版本 Tag 及 Release。
|
||||
- 编写版本新特性说明文档。
|
||||
- 编写 GitHub Release 版本英文日志,参考[版本对比](https://github.com/RT-Thread/rt-thread/compare/v5.0.1...v5.0.2)。
|
||||
- 发布社区公众号版本发布推文。
|
||||
- 举办版本发布会。
|
||||
|
||||
### 2. 其他工作
|
||||
|
||||
- 在社区发布版本意见征集帖,邀请开发者参与讨论。
|
||||
- 更新 RT-Thread Studio 工程文件,发布新版本工程。
|
||||
- 更新商业网站的芯片支持情况,主要更新新支持的架构,参考[芯片支持页面](https://www.rt-thread.com/products/Chip-39.html)。
|
||||
- 在文档中心更新新支持功能的文档及链接,参考[文档中心](https://www.rt-thread.org/document/site/#/)。
|
||||
- 更新官方网站 RT-Thread 源代码网盘下载链接,参考[源代码下载页面](https://www.rt-thread.org/download.html#download-rt-thread-source-code)。
|
||||
|
||||

|
||||
|
||||
## 版本发布流程总视图
|
||||
|
||||

|
||||
|
||||
## 参考资料
|
||||
|
||||
- [腾讯文档:版本发布流程视图](https://docs.qq.com/flowchart/DVGpndnRmTHdkc3Ji)
|
||||
@@ -0,0 +1,196 @@
|
||||
@page page_release_process_en RT-Thread Release Process
|
||||
|
||||
# RT-Thread Release Process
|
||||
|
||||
[中文](https://github.com/RT-Thread/rt-thread/blob/master/documentation/7.contribution/release_process_cn.md) | [Versioning Policy and Implementation Rules](@ref page_release_versioning_en)
|
||||
|
||||
This document describes the six stages of an RT-Thread mainline release, from requirements preparation to publication. See the [Versioning Policy and Implementation Rules](@ref page_release_versioning_en) for version classification, compatibility requirements, and the release checklist.
|
||||
|
||||
## Stage 1: Release Preparation
|
||||
|
||||
### 1. Primary Goal
|
||||
|
||||
- Finalize the development tasks for this release and create a view of the release development tasks.
|
||||
|
||||
### 2. Main Activities
|
||||
|
||||
#### Key Activities
|
||||
|
||||
- Prepare the release draft: review the previous release completion report and development draft to create an initial plan for this release.
|
||||
- Organize GitHub issues: review unresolved issues from earlier releases, collect issues for new features, and mark them with release labels.
|
||||
|
||||
#### Other Activities
|
||||
|
||||
- Collect requirements from other departments and consolidate functional requirements into a requirements document.
|
||||
- Evaluate emerging technologies for possible integration into the mainline, recording proposals as issues or discussions.
|
||||
- Compare the performance of similar products and identify useful features to introduce, recording findings as issues or discussions.
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["Release preparation"] --> B["Prepare release draft"]
|
||||
B --> B1["Previous release completion report"]
|
||||
B --> B2["Previous release development draft"]
|
||||
A --> C["Organize GitHub issues"]
|
||||
C --> C1["Unresolved issues from earlier releases"]
|
||||
C --> C2["New feature issues"]
|
||||
A --> D["Collect departmental requirements"]
|
||||
D --> D1["Functional requirements report with target version"]
|
||||
A --> E["Evaluate emerging technologies"]
|
||||
E --> E1["Technology outlook discussions"]
|
||||
A --> F["Analyze competing products"]
|
||||
```
|
||||
|
||||
## Stage 2: Define Initial Goals for the Next Release
|
||||
|
||||
### 1. Primary Goal
|
||||
|
||||
- Define the initial tasks for the next release.
|
||||
|
||||
### 2. Main Activities
|
||||
|
||||
1. Collect community requirements and feedback as issues, starting after the previous release is published.
|
||||
2. Group the issues into milestones.
|
||||
3. Define the initial goals for the next release.
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A["GitHub issues"] --> B["GitHub milestones"]
|
||||
B --> C["Initial goals for the next release"]
|
||||
```
|
||||
|
||||
## Stage 3: Development Preparation
|
||||
|
||||
### 1. Primary Goal
|
||||
|
||||
- Assign development tasks using the release development task view.
|
||||
|
||||
### 2. Main Activities
|
||||
|
||||
- Assign developers to the development tasks for this release.
|
||||
- Assign reviewers to PRs for different features.
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["Development preparation"] --> B["Distribute tasks"]
|
||||
B --> C["Meet to agree on detailed assignments"]
|
||||
A --> D["Assign PR reviewers"]
|
||||
D --> C
|
||||
D --> E["Kernel"]
|
||||
D --> F["Drivers"]
|
||||
D --> G["Components"]
|
||||
D --> H["BSPs"]
|
||||
D --> I["CI"]
|
||||
D --> J["Other areas"]
|
||||
```
|
||||
|
||||
## Stage 4: Release Development
|
||||
|
||||
### 1. Primary Goal
|
||||
|
||||
- Track progress and announce the feature freeze in advance.
|
||||
|
||||
### 2. Main Activities
|
||||
|
||||
- Complete the release development goals and record progress in the release plan.
|
||||
- For core PRs, announce the feature freeze two weeks before release.
|
||||
- Mark new feature PRs from community developers with GitHub labels.
|
||||
- Process routine PRs throughout release development.
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["Release development"] --> B["Routine PRs throughout mainline development"]
|
||||
A --> C["Core PRs: announce feature freeze in advance"]
|
||||
C --> D["Advance release development tasks"]
|
||||
C --> E["Include community feature PRs identified by GitHub labels"]
|
||||
```
|
||||
|
||||
## Stage 5: Pre-release
|
||||
|
||||
### 1. Primary Goal
|
||||
|
||||
- Stabilize features and complete bug regression testing.
|
||||
|
||||
### 2. Main Activities
|
||||
|
||||
#### Core Activities
|
||||
|
||||
- Stabilize the feature set by following up with authors to complete the merging of new feature PRs.
|
||||
- Complete bug regression testing and collect release issues reported by the community, covering both development and published versions.
|
||||
|
||||
#### Testing
|
||||
|
||||
- Use the release test case template to test different architectures, BSPs, kernels, components, peripherals, file systems, and other areas, and record issues. See the [previous release test case document](https://docs.qq.com/sheet/DYUFZbEdrek1KWFd4).
|
||||
|
||||
#### Reporting
|
||||
|
||||
- Combine release development task progress with a summary of new feature PRs from community developers to produce a release task completion report.
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["Pre-release"] --> B["Core activities"]
|
||||
B --> C["Feature stabilization"]
|
||||
B --> D["Bug regression testing"]
|
||||
D --> E["Community-reported issues"]
|
||||
E --> F["Collect release issues and record version numbers"]
|
||||
A --> G["Testing"]
|
||||
A --> H["Reporting"]
|
||||
H --> I["Release development task progress"]
|
||||
H --> J["Summary of community feature PRs"]
|
||||
I --> K["Release task completion report"]
|
||||
J --> K
|
||||
F --> K
|
||||
```
|
||||
|
||||
## Stage 6: Release Publication
|
||||
|
||||
### 1. Key Activities
|
||||
|
||||
- Publish the version tag and release on GitHub.
|
||||
- Publish the version tag and release on Gitee.
|
||||
- Write documentation describing the new features in the release.
|
||||
- Write the English changelog for the GitHub release. See the [version comparison example](https://github.com/RT-Thread/rt-thread/compare/v5.0.1...v5.0.2).
|
||||
- Publish the release announcement on the community's WeChat official account.
|
||||
- Hold a release launch event.
|
||||
|
||||
### 2. Other Activities
|
||||
|
||||
- Publish a community thread inviting developers to discuss the release and provide feedback.
|
||||
- Update RT-Thread Studio project files and publish projects for the new version.
|
||||
- Update chip support information on the commercial website, focusing on newly supported architectures. See the [chip support page](https://www.rt-thread.com/products/Chip-39.html).
|
||||
- Update documentation and links for newly supported features in the [documentation center](https://www.rt-thread.org/document/site/#/).
|
||||
- Update the cloud download link for RT-Thread source code on the official website. See the [source code download page](https://www.rt-thread.org/download.html#download-rt-thread-source-code).
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["Release publication"] --> B["Publish tags and releases"]
|
||||
B --> B1["GitHub"]
|
||||
B --> B2["Gitee"]
|
||||
A --> C["New feature documentation"]
|
||||
A --> D["Release communications"]
|
||||
D --> D1["English GitHub release changelog"]
|
||||
D --> D2["WeChat release announcement"]
|
||||
A --> E["Release launch event"]
|
||||
A --> F["Other activities"]
|
||||
F --> F1["Community feedback thread"]
|
||||
F --> F2["RT-Thread Studio project updates"]
|
||||
F --> F3["Commercial website updates"]
|
||||
F --> F4["Documentation center updates"]
|
||||
F --> F5["Official source code download link update"]
|
||||
```
|
||||
|
||||
## Release Process Overview
|
||||
|
||||
The diagrams above detail the activities within each stage. The overall sequence is:
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
A["1. Release preparation"] --> B["2. Initial goals for the next release"]
|
||||
B --> C["3. Development preparation"]
|
||||
C --> D["4. Release development"]
|
||||
D --> E["5. Pre-release"]
|
||||
E --> F["6. Release publication"]
|
||||
```
|
||||
|
||||
## References
|
||||
|
||||
- [Tencent Docs: Release Process Diagram](https://docs.qq.com/flowchart/DVGpndnRmTHdkc3Ji)
|
||||
@@ -932,6 +932,8 @@ EXCLUDE = ./0.doxygen/mainpage.h \
|
||||
./env/env-vscode.md \
|
||||
./7.contribution/coding_style_cn.md \
|
||||
./7.contribution/bsp_contribution_guide_cn.md \
|
||||
./7.contribution/release_versioning_cn.md \
|
||||
./7.contribution/release_process_cn.md \
|
||||
../src/utest/perf/README.md
|
||||
|
||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
||||
|
||||
@@ -1022,6 +1022,8 @@ EXCLUDE = ./0.doxygen/mainpage.h \
|
||||
./env/env-vscode.md \
|
||||
./7.contribution/coding_style_cn.md \
|
||||
./7.contribution/bsp_contribution_guide_cn.md \
|
||||
./7.contribution/release_versioning_cn.md \
|
||||
./7.contribution/release_process_cn.md \
|
||||
../src/utest/perf/README.md
|
||||
|
||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
||||
|
||||