Skip to content

Conversation

@JamieSinn
Copy link
Member

No description provided.

Copy link
Contributor

Copilot AI left a 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 <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 17, 2025 16:06
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a 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.


# SDK Release Lifecycle

DevCycle Supports each SDK version according to the policies outlined below. If an SDK is out of support, we recommend
Copy link

Copilot AI Oct 17, 2025

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'.

Suggested change
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

Copilot uses AI. Check for mistakes.

- **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.
Copy link

Copilot AI Oct 17, 2025

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.

Suggested change
- **PATCH** version is incremented for optional bug-fixes and security updates.
- **PATCH** version is incremented for optional bug fixes and security updates.

Copilot uses AI. Check for mistakes.
- **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
Copy link

Copilot AI Oct 17, 2025

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.

Suggested change
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

Copilot uses AI. Check for mistakes.
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 17, 2025

Deploying devcycle-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: cf4cfb4
Status: ✅  Deploy successful!
Preview URL: https://3d9b60e2.devcycle-docs.pages.dev
Branch Preview URL: https://release-lifecycle.devcycle-docs.pages.dev

View logs

@JamieSinn JamieSinn requested a review from Copilot October 17, 2025 16:47
Copy link
Contributor

Copilot AI left a 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 <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 17, 2025 16:48
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a 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.

@JamieSinn JamieSinn requested a review from Copilot October 28, 2025 19:07
Copy link
Contributor

Copilot AI left a 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.


## Support Timeline

We actively support the most recent 2 releases (major, minor) of each SDK. Support includes:
Copy link

Copilot AI Oct 28, 2025

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'.

Suggested change
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:

Copilot uses AI. Check for mistakes.
Copy link
Member Author

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 <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 28, 2025 19:11
Copy link

Copilot AI commented Oct 28, 2025

@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.

Copy link
Contributor

Copilot AI left a 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 <1538232+JamieSinn@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JamieSinn <1538232+JamieSinn@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants