-
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
base: main
Are you sure you want to change the base?
feat: SDK EOL Policy #925
Conversation
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.
Pull Request Overview
This PR adds documentation for DevCycle's SDK End-of-Life (EOL) policy, introducing a new lifecycle documentation section that outlines support timelines, versioning practices, and upgrade policies for SDKs.
- Added comprehensive SDK lifecycle documentation covering support timeline, upgrade policies, and EOL procedures
- Integrated new lifecycle section into the documentation sidebar structure
- Added appropriate styling for the new lifecycle section with roadmap icon
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/sdk/lifecycle.md | New documentation outlining SDK support policies, versioning, and EOL timelines |
| sidebars.js | Added lifecycle section entry to SDK documentation navigation |
| src/css/custom.css | Added CSS styling for lifecycle section with roadmap icon |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
docs/sdk/lifecycle.md
Outdated
|
|
||
| # SDK Release Lifecycle | ||
|
|
||
| DevCycle Supports each SDK version according to the policies outlined below. If an SDK is out of support, we recommend |
Copilot
AI
Oct 17, 2025
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.
Corrected capitalization of 'Supports' to 'supports'.
| DevCycle Supports each SDK version according to the policies outlined below. If an SDK is out of support, we recommend | |
| DevCycle supports each SDK version according to the policies outlined below. If an SDK is out of support, we recommend |
docs/sdk/lifecycle.md
Outdated
|
|
||
| - **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 optional bug-fixes and security updates. |
Copilot
AI
Oct 17, 2025
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.
The term 'bug-fixes' should be 'bug fixes' (without hyphen) for consistency with standard technical writing.
| - **PATCH** version is incremented for optional bug-fixes and security updates. | |
| - **PATCH** version is incremented for optional bug fixes and security updates. |
| - **MINOR** version is incremented for adding functionality in a backwards-compatible manner, and | ||
| - **PATCH** version is incremented for optional 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 |
Copilot
AI
Oct 17, 2025
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.
| For our SDKs, the latest version is defined as the highest MAJOR.MINOR version available. To see the latest version of | |
| For our SDKs, the latest version is defined as the highest MAJOR.MINOR version available. To see the latest version of |
Deploying devcycle-docs with
|
| Latest commit: |
cf4cfb4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3d9b60e2.devcycle-docs.pages.dev |
| Branch Preview URL: | https://release-lifecycle.devcycle-docs.pages.dev |
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.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/sdk/lifecycle.md
Outdated
|
|
||
| ## Support Timeline | ||
|
|
||
| We actively support the most recent 2 releases (major, minor) of each SDK. Support includes: |
Copilot
AI
Oct 28, 2025
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.
The phrase 'most recent 2 releases (major, minor)' is ambiguous. It's unclear whether this means the 2 most recent major versions, the 2 most recent minor versions, or some combination. Consider clarifying with a specific example, such as 'the current major version and the previous major version' or 'the 2 most recent minor versions within the current major version'.
| We actively support the most recent 2 releases (major, minor) of each SDK. Support includes: | |
| We actively support the current major version and the previous major version of each SDK. Support includes: |
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.
@copilot this is intended to mean that the following versions are supported:
2.1.0 - Supported
2.0.0 - Supported
1.9.0 - Not supported
Co-authored-by: Copilot <[email protected]>
|
@JamieSinn I've opened a new pull request, #930, to work on those changes. Once the pull request is ready, I'll request review from you. |
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.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
* Initial plan * Clarify version support policy with specific example Co-authored-by: JamieSinn <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: JamieSinn <[email protected]>
No description provided.