Skip to content

Commit

Permalink
Merge pull request #522 from Shelley-BaoYue/release-cycle
Browse files Browse the repository at this point in the history
add patch release management doc
  • Loading branch information
kubeedge-bot authored Mar 4, 2024
2 parents 6203f1b + 5c09f24 commit cab43e1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
16 changes: 14 additions & 2 deletions docs/community/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Release Management
sidebar_position: 5
---

## KubeEdge Release Cycle

KubeEdge releases currently happen approximately every three months.

![release cycle](/img/community/release-cycle.png)
Expand All @@ -25,8 +27,18 @@ The release process can be thought of as having four main phases:

Once the first three phases are comleted, the release branch enters the final stage. The community prepares for the official release by conducting thorough testing and ensuring documentation and release notes are up-to-date. Following this, the final version is officially released and made available for public use.

When the code base is sufficiently stable, the master branch opens for general development and work begins there for the next release milestone. Any remaining modifications for the current release are cherry picked from master back to the release branch. The release is built from the release branch.
When the code base is sufficiently stable, the master branch opens for general development and work begins there for the next release milestone.

## Patch Release

Our typical patch release cadence is monthly. If there are critical issues present in the current version, an expedited release may be necessary.

### Cherry Picks

Any remaining modifications for the current release are cherry picked from master back to the release branch. Cherry picks must be merge-ready in GitHub with proper labels (e.g., approved, lgtm, release-note) and passing CI tests ahead of the patch release deadline.

### Support Versions

Each release is part of a broader KubeEdge lifecycle:
We provide maintenance for the latest three releases. This means that bug fixes will be applied to these releases to ensure their stability and reliability. However, in exceptional cases where severe issues arise, we may consider releasing patches for earlier versions as well, based on the specific circumstances.

![release lifecycle](/img/community/release-lifecycle.png)
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: 版本管理
sidebar_position: 5
---

## KubeEdge 版本周期

KubeEdge 目前大约每三个月会发布一个版本。

![release cycle](/img/community/release-cycle.png)
Expand All @@ -25,8 +27,18 @@ KubeEdge 目前大约每三个月会发布一个版本。

完成前三个阶段后,版本进入最后的发布准备阶段。社区通过进行测试、文档和版本Changelog来准备正式发布。随后,最终版本正式发布并可供公众使用。

当代码库足够稳定时,主分支将开放进行开发,并从开始下一个版本的工作。 当前版本的任何修改都是从 master 分支cherry-pick回版本分支。发布版本是从版本release分支构建的。
当代码库足够稳定时,主分支将开放进行开发,并从开始下一个版本的工作。

## 补丁版本

补丁版本通常是每月发布一次,如果出现严重问题需要修复,社区也会缩短发布周期,尽快发布补丁版本。

### Cherry Picks

当前版本的任何修改都是从 master 分支cherry-pick回版本分支。Cherry-Pick的PR必须在 GitHub 中准备好合并,带有approved和lgtm标签, 并在补丁版本发布截止日期之前通过 CI 测试。

### 支持的版本

每个版本都是更广泛的 KubeEdge 生命周期的一部分:
通常社区会维护最新三个版本的补丁发布,这意味着问题修复可以合入最新三个版本来保证版本的稳定性与可靠性。如果出现严重问题,社区会根据具体情况考虑对更早的版本发布补丁。

![release lifecycle](/img/community/release-lifecycle.png)

0 comments on commit cab43e1

Please sign in to comment.