From 23f7edfd80c230e987832dd0352d0bbcd7b4af5b Mon Sep 17 00:00:00 2001 From: cloudant-sdks-automation <71659186+cloudant-sdks-automation@users.noreply.github.com> Date: Thu, 7 Sep 2023 16:07:24 +0000 Subject: [PATCH] docs(generated): clarify LTS support and semver info Generated SDK source code using: - Generator version 3.76.0 - Specification version 1.0.0-dev0.0.52 - Automation (cloudant-sdks) version 91a0802 Signed-off-by: cloudant-sdks-automation <71659186+cloudant-sdks-automation@users.noreply.github.com> --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 80794c2de..47f6c3499 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ to avoid surprises. - [Stopping the changes follower](#stopping-the-changes-follower) - [Questions](#questions) - [Issues](#issues) +- [Versioning and LTS support](#versioning-and-lts-support) - [Open source at IBM](#open-source-at-ibm) - [Contributing](#contributing) - [License](#license) @@ -1116,6 +1117,26 @@ Before you submit a bug report, search for Please consult the [security policy](https://github.com/IBM/cloudant-java-sdk/security/policy) before opening security related issues. +## Versioning and LTS support + +This SDK follows semantic versioning with respect to the definition of user facing APIs. +This means under some circumstances breaking changes may occur within a major or minor version +of the SDK related to changes in supported language platforms. + +The SDK is supported on the available LTS releases of the language platform. +The LTS language versions are listed in the prerequisites: +* [LTS versions currently supported by the SDK](https://github.com/IBM/cloudant-java-sdk/#prerequisites) +* [LTS versions for this release of the SDK](#prerequisites) + +Incompatible changes from new language versions are not added to the SDK +until they are available in the minimum supported language version. + +When language LTS versions move out of support the following will happen: +* Existing SDK releases will continue to run on obsolete language versions, but will no longer be supported. +* The minimum language version supported by the SDK will be updated to the next available LTS. +* New language features may be added in subsequent SDK releases that will cause breaking changes + if the new releases of the SDK are used with older, now unsupported, language levels. + ## Open source at IBM Find more open source projects on the [IBM GitHub](http://ibm.github.io/) page.