Skip to content

Commit

Permalink
docs(generated): clarify LTS support and semver info
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
cloudant-sdks-automation authored and ricellis committed Sep 7, 2023
1 parent e72a157 commit 100b88e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 100b88e

Please sign in to comment.