From da660d3f27ed7e369e565012ed248b324aba1c8f Mon Sep 17 00:00:00 2001 From: Takahiro Itazuri Date: Mon, 16 Oct 2023 13:18:00 +0000 Subject: [PATCH] docs: Update removal policy of deprecated API elements Simplify and clarify the rules which we follow to remove deprecated API elements. See also GitHub discussion #4157. Signed-off-by: Takahiro Itazuri --- CHANGELOG.md | 5 +++++ docs/RELEASE_POLICY.md | 18 ++++++------------ 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7ca0eae658d..9eca11f5f79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ ### Changed +- Simplified and clarified the removal policy of deprecated API elements + to follow semantic versioning 2.0.0. For more information, please refer to + [this GitHub discussion](https://github.com/firecracker-microvm/firecracker/discussions/4135). + ### Deprecated ### Fixed @@ -71,6 +75,7 @@ [`Warn`](https://docs.rs/log/latest/log/enum.Level.html#variant.Warn) to [`Info`](https://docs.rs/log/latest/log/enum.Level.html#variant.Info). This results in more logs being output by default. + ### Fixed - Fixed a change in behavior of normalize host brand string that breaks diff --git a/docs/RELEASE_POLICY.md b/docs/RELEASE_POLICY.md index b7bd0d8148d..99448a485b4 100644 --- a/docs/RELEASE_POLICY.md +++ b/docs/RELEASE_POLICY.md @@ -109,18 +109,12 @@ work as expected with all Firecracker binary versions X.V.W, where V >= Y. ### Deprecation of elements in the API -We will consider a deprecated API endpoint to be an endpoint which still has -backing functionality and can be used, but will be removed completely along -with said functionality in an upcoming API version. All deprecated endpoints -are supported until at least the next MAJOR version release, where they _may -be removed_. - -When elements of the API are deprecated in a MINOR release, they will still -work for the longest of the following: - -* all subsequent Firecracker MINOR releases of the same MAJOR release; -* any Firecracker MINOR release for at least 6 months from release date; -* the next 2 Firecracker releases, regardless if they are MAJOR or MINOR. +Firecracker uses [semantic versioning 2.0.0](https://semver.org/spec/v2.0.0.html) +in terms of deprecating and removing API elements. We will consider a deprecated +API element to be an element which still has backing functionality and will be +supported at least until the next MAJOR version, where they _will be removed_. +The support period of deprecated API elements is tied to +[the Firecracker release support](https://github.com/firecracker-microvm/firecracker/blob/main/docs/RELEASE_POLICY.md#release-support). ## Developer preview features