-
Notifications
You must be signed in to change notification settings - Fork 22
feat: SDK EOL Policy #925
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JamieSinn
wants to merge
7
commits into
main
Choose a base branch
from
release-lifecycle
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
feat: SDK EOL Policy #925
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
16f7526
SDK EOL Policy
JamieSinn b9c0602
Update docs/sdk/lifecycle.md
JamieSinn 140139b
Update docs/sdk/lifecycle.md
JamieSinn f8940e7
Update docs/sdk/lifecycle.md
JamieSinn 5eb4f28
Update docs/sdk/lifecycle.md
JamieSinn a0698fa
Update docs/sdk/lifecycle.md
JamieSinn cf4cfb4
Clarify SDK version support policy with concrete example (#930)
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: SDK Release Lifecycle | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # SDK Release Lifecycle | ||
|
|
||
| DevCycle supports each SDK version according to the policies outlined below. If an SDK is out of support, we recommend | ||
| upgrading to a supported version to ensure you have access to the latest features, improvements, and security updates. | ||
|
|
||
| We only backport critical bug fixes and security patches to previous major versions of our SDKs. New features and | ||
| non-critical bug fixes are only added to the latest major version. | ||
|
|
||
| We follow [Semantic Versioning](https://semver.org/) for all our SDKs. This means that version numbers are in the format | ||
| of `MAJOR.MINOR.PATCH`, where: | ||
|
|
||
| - **MAJOR** version is incremented for incompatible API changes, | ||
| - **MINOR** version is incremented for adding functionality in a backwards-compatible manner, and | ||
| - **PATCH** version is incremented for backwards-compatible bug fixes and security updates. | ||
|
|
||
| For our SDKs, the latest version is defined as the highest MAJOR.MINOR version available. To see the latest version of | ||
| each SDK, visit the respective SDK GitHub repository or package manager page in the case of JS/Node SDKs. | ||
|
|
||
| ## Support Timeline | ||
|
|
||
| We actively support the 2 most recent minor versions of each SDK. For example, if the latest versions are 2.1.0 and 2.0.0, both are supported, but 1.9.0 is not. Support includes: | ||
|
|
||
| - Bug fixes | ||
| - Security patches | ||
| - Technical support | ||
|
|
||
| Due to the rapid pace of development, we cannot guarantee updates for versions older than the most recent 2 releases. We | ||
| recommend upgrading to a supported version to ensure you have access to the latest features and improvements. Critical | ||
| Security patches may be backported to older versions at our discretion. | ||
|
|
||
| ## Upgrade Policy | ||
|
|
||
| When a new major version of an SDK is released, we recommend upgrading to the latest version as soon as possible to take | ||
| advantage of new features and improvements. If required, we provide detailed release notes and migration guides to | ||
| assist with the upgrade process. | ||
|
|
||
| ## End of Support (EOS) | ||
|
|
||
| SDK versions automatically transition to EOS status 6 months after a new major version is released. | ||
| When an SDK version reaches its end of support, we cannot guarantee technical support for that | ||
| version. | ||
|
|
||
| ## End of Life (EOL) | ||
|
|
||
| SDK versions automatically transition to EOL status 12 months after a new major version is released. | ||
| When an SDK version reaches its end of life, we will no longer provide support or updates for that version. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace semicolon with comma for better readability and grammatical correctness.