From 540e5774d99ec43885db42c52e477ec09760b1f7 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Thu, 13 Aug 2020 18:11:44 +1000 Subject: [PATCH] doc: Update support period policy document Chinese translation to follow. --- SUPPORT_POLICY.md | 73 ++++++++++++++++++++++++++------------------ SUPPORT_POLICY_CN.md | 56 ++++++++++++++++++++------------- 2 files changed, 78 insertions(+), 51 deletions(-) diff --git a/SUPPORT_POLICY.md b/SUPPORT_POLICY.md index 7e0e272cc4..eed44025da 100644 --- a/SUPPORT_POLICY.md +++ b/SUPPORT_POLICY.md @@ -5,43 +5,49 @@ Support Period Policy * [中文版](./SUPPORT_POLICY_CN.md) -Each ESP-IDF major and minor release (V4.0, V4.1, etc) is supported for -18 months after the initial stable release date. +Each ESP-IDF major and minor release (V4.1, V4.2, etc) is supported for +30 months after the initial stable release date. Supported means that the ESP-IDF team will continue to apply bug fixes, security fixes, etc to the release branch on GitHub, and periodically make new bugfix releases as needed. -Users are encouraged to upgrade to a newer ESP-IDF release before the -support period finishes and the release becomes End of Life (EOL). It is -our policy to not continue fixing bugs in End of Life releases. +Support period is divided into "Service" and "Maintenance" period: + +| Period | Duration | Recommended for new projects? | +| ------- | ------------ | ------------------------------------- | +| Service | 12 months | Yes | +| Maintenance | 18 months | No | + +During the Service period, bugfixes releases are more frequent. In some cases, +support for new features may be added during the Service period (this is +reserved for features which are needed to meet particular regulatory +requirements or standards for new products, and which carry a very low risk of +introducing regressions.) + +During the Maintenace period, the version is still supported but only bugfixes +for high severity issues or security issues will be applied. + +Using an “In Service” version is recommended when starting a new project. + +Users are encouraged to upgrade all projects to a newer ESP-IDF release before +the support period finishes and the release becomes End of Life (EOL). It is our +policy to not continue fixing bugs in End of Life releases. Pre-release versions (betas, previews, `-rc` and `-dev` versions, etc) are not covered by any support period. Sometimes a particular feature is -marked as \"Preview\" in a release, which means it is also not covered +marked as "Preview" in a release, which means it is also not covered by the support period. The ESP-IDF Programming Guide has information about the [different versions of ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html) (major, minor, bugfix, etc). -Long Term Support releases --------------------------- - -Some releases (starting with ESP-IDF V3.3) are designated Long Term -Support (LTS). LTS releases are supported for 30 months (2.5 years) -after the initial stable release date. - -A new LTS release will be made at least every 18 months. This means -there will always be a period of at least 12 months to upgrade from the -previous LTS release to the following LTS release. - Example ------- -ESP-IDF V3.3 was released in September 2019 and is a Long Term Support -(LTS) release, meaning it will be supported for 30 months until February -2022. +ESP-IDF V3.3 was released in September 2019. It will be supported for 30 months +until February 2022. - The first V3.3 release was `v3.3` in September 2019. - The ESP-IDF team continues to backport bug fixes, security fixes, @@ -55,14 +61,23 @@ ESP-IDF V3.3 was released in September 2019 and is a Long Term Support Existing Releases ----------------- -ESP-IDF release V3.3 and all newer releases will follow this support -period policy. The support period for each release will be announced -when the release is made. +ESP-IDF release V4.1 and all newer releases will follow this support period +policy. The support period for each release will be announced when the release +is made. -For releases made before the support period policy was announced, -the following support periods apply: +For releases made before the current support period policy was announced, the +original support periods apply: -- ESP-IDF V3.1.x and V3.2.x will both be supported until October 2020. -- ESP-IDF V3.0.9 (planned for October 2019) will be the last V3.0 - bugfix release. ESP-IDF V3.0.x is End of Life from October 2019. -- ESP-IDF versions before V3.0 are already End of Life. +* ESP-IDF V4.0.x will be supported until October 2021 +* ESP-IDF V3.3.x will be supported until February 2022 +* ESP-IDF V3.1.x and V3.2.x will both be supported until October 2020. +* ESP-IDF versions before V3.1 are already End of Life. + +Policy History +-------------- + +* September 2019. This policy split ESP-IDF releases into Standard and Long Term + Support. +* July 2020. All releases from now will have the same support period, which is + equal to the previous Long Term Support period. Added “In Service” period, + during which versions will receive more updates. diff --git a/SUPPORT_POLICY_CN.md b/SUPPORT_POLICY_CN.md index 3b781f1d78..8f0c9b2708 100644 --- a/SUPPORT_POLICY_CN.md +++ b/SUPPORT_POLICY_CN.md @@ -1,43 +1,55 @@ -有关 ESP-IDF 的最新支持政策，详见 [支持期限政策](./SUPPORT_POLICY_CN.md)。 +有关 ESP-IDF 的最新支持政策，详见 [支持期限政策](https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY_CN.md) + 支持期限政策 -================= +===================== -* [English Version](./SUPPORT_POLICY.md) +ESP-IDF 的每个主要版本和次要版本（如 V4.1、V4.2 等）自其首次稳定版本发布之日起将支持 30 个月。 -ESP-IDF 的每个主要版本和次要版本（如 V4.0、V4.1 等）自其首次稳定版本发布之日起将维护 18 个月。 +支持意味着 ESP-IDF 团队将会对 GitHub 上的发布分支继续进行 bug 修复、安全修补等，并根据需求定期发布新的 bugfix 版本。 -维护意味着 ESP-IDF 团队将会对 GitHub 上的发布分支继续进行 bug 修复、安全修补等，并根据需求定期发布新的 bugfix 版本。 +支持周期包括“服务周期“和“维护周期”： -在某一版本支持期限结束，停止更新维护 (EOL) 前，建议用户升级到较新的 ESP-IDF 版本。根据《支持期限政策》，我们将停止对 EOL 版本进行 bug 修复。 +| 周期 | 期限 | 是否建议新项目使用？ | +| ------- | ------------ | ------------------------------------- | +| 服务周期 | 12 个月 | 是 | +| 维护周期 | 18 个月 | 否 | -《支持期限政策》不适用于预发布版本（包括 beta、preview、`-rc` 和 `-dev` 版本等）。有时，在发布的版本中存在被标记为 "Preview" 的特定功能，则该功能也不在支持期限内。 +在版本的服务周期内，bug 修复版本会较为频繁发布。某些情况下，版本在其服务周期内可能会增加对新功能的支持（这仅适用于需要达到新产品特定规管标准或要求的功能，并且引入新问题的风险极低。） -有关 [ ESP-IDF 不同版本](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/versions.html)（主要版本、次要版本、bugfix 版本等）信息，可参阅《ESP-IDF 编程指南》。 +在版本的维护周期内，版本仍然会继续支持，但仅会对严重问题或安全问题进行 bug 修复。 -长期支持版本 ------------- +建议在开始新项目的时候使用处于服务周期的版本。 -有些发布版本（从 ESP-IDF V3.3 开始）属于长期支持 (LTS) 版本。LTS 版本将自其首次稳定版本发布之日起维护 30 个月（2.5 年）。 +在某一版本支持期限结束，停止更新维护 (EOL) 前，建议用户升级所有项目至较新的 ESP-IDF 版本。根据《支持期限政策》，我们将停止对 EOL 版本进行 bug 修复。 -我们将至少每 18 个月发布一个新的 LTS 版本。这意味着将至少有 12 个月的期限可更新至下一个 LTS 版本。 +《支持期限政策》不适用于预发布版本（包括 beta、preview、-rc 和 -dev 版本等）。有时，在发布的版本中存在被标记为 "Preview" 的特定功能，则该功能也不在支持期限内。 + +有关 [ESP-IDF 不同版本](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/versions.html)（主要版本、次要版本、bugfix 版本等）信息，可参阅《ESP-IDF 编程指南》。 示例 ------ +------- -ESP-IDF V3.3 于 2019 年 9 月发布，属于 LTS 版本，将维护 30 个月至 2022 年 2 月停止。 +ESP-IDF V3.3 于 2019 年 9 月发布，将支持 30 个月至 2022 年 2 月停止。 -- V3.3 的首个发布版本为 2019 年 9 月发布的 `v3.3`。 -- ESP-IDF 团队将持续进行 bug 修复、安全修补等更新，并 backport 至分支 `release/v3.3`。 -- 定期从 release 分支创建稳定的 bugfix 版本，比如，`v3.3.1`、`v3.3.2` 等，并建议用户保持使用最新的 bugfix 版本。 +- V3.3 的首个发布版本为 2019 年 9 月发布的 v3.3。 +- ESP-IDF 团队将持续进行 bug 修复、安全修补等更新，并 backport 至分支 release/v3.3。 +- 定期从 release 分支创建稳定的 bugfix 版本，比如，v3.3.1、v3.3.2 等，并建议用户保持使用最新的 bugfix 版本。 - V3.3 的 bugfix 版本发布将持续至 2022 年 2 月，届时所有 V3.3.x 将停止更新维护。 现有版本 --------- +----------------- -ESP-IDF V3.3 及所有后续更新版本都将遵守该《支持期限政策》。每一版本发布时将同时公布其支持期限。 +ESP-IDF V4.1 及所有后续更新版本都将遵守该《支持期限政策》。每一版本发布时将同时公布其支持期限。 对于该政策公布之日前发布的版本，应适用下述支持期限： -- ESP-IDF V3.1.x 和 V3.2.x 将维护至 2020 年 10 月。 -- ESP-IDF V3.0.9（计划 2019 年 10 月发布）将是 V3.0 的最后一个 bugfix 版本。ESP-IDF V3.0.x 自 2019 年 10 月起停止更新维护 (EOL)。 -- ESP-IDF 中 V3.0 之前的版本均已停止更新维护 (EOL)。 +* ESP-IDF V4.0.x 将支持至 2021 年 10 月。 +* ESP-IDF V3.3.x 将支持至 2022 年 2 月。 +* ESP-IDF V3.1.x 和 V3.2.x 都将在 2020 年 10 月停止支持。 +* ESP-IDF v3.1.x 之前的版本已经停止支持。 + +政策历史 +-------------- + +* 2019 年 9 月。该政策将 ESP-IDF 版本发布分为标准支持版本和长期支持版本。 +* 2020 年 7 月。从现在开始，所有发布的版本都将有相同的支持周期，等同于之前的长期支持周期。新增了”服务周期“，期间版本的更新将较为频繁。