Unify release family lifecycle policy source#313
Conversation
Make sdk/latest/release-family the canonical source for lifecycle/support windows and remove duplicated lifecycle timelines from sdk/latest/security/security-policy to prevent policy drift. Made-with: Cursor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Greptile SummaryThis PR restructures cross-linking between
Confidence Score: 3/5Not safe to merge: lifecycle policy content has been deleted without being relocated, and next/ pages are out of sync. Two P1 findings: the claimed canonical page is missing the substantive content that was removed from security-policy, and the required next/ sync was skipped. The structural goal of the PR is sound, but in its current state it leaves the docs worse than before. sdk/latest/release-family.mdx needs the lifecycle policy details added; sdk/next/release-family.mdx and sdk/next/security/security-policy.mdx need to be synced. Important Files Changed
|
| A release family is a curated set of component versions across the Cosmos Stack that are tested for compatibility with one another. Cosmos Labs provides maintenance and bug fixes only for active families. For lifecycle policy and maintenance windows, see the [Security and Maintenance Policy](/sdk/latest/security/security-policy). | ||
| A release family is a curated set of component versions across the Cosmos Stack that are tested for compatibility with one another. Cosmos Labs provides maintenance and bug fixes only for active families. | ||
|
|
||
| This page is the canonical source of truth for release family lifecycle, active support windows, and retirement expectations. |
There was a problem hiding this comment.
Claimed canonical page missing lifecycle details
release-family.mdx is now declared the canonical source for lifecycle policy, but the content that was removed from security-policy.mdx was never added here. Readers who follow the pointer will find no information about:
- The one-year maintenance window policy
- The two-families-per-year cadence
- What happens when a successor family is delayed
- EOL notices (CometBFT v0.37.x, ibc-go v0.7.x, SDK v0.50.x)
- Future family evolution
The lifecycle policy has been effectively deleted from both pages, not consolidated.
Add lifecycle and EOL policy details to release-family, keep security-policy as a pointer page, and sync corresponding next/ pages to satisfy latest-next parity requirements. Made-with: Cursor
|
Addressed review feedback in commit 2de6838:\n\n- Added lifecycle and EOL policy details to so the canonical page contains substantive policy content.\n- Synced counterparts (, ) to match the latest changes.\n- Added branch work-log entry per repo guidance. |
|
Follow-up after review:\n\n- Added lifecycle and EOL policy details directly to sdk/latest/release-family.mdx so the canonical page now contains substantive policy content.\n- Synced next pages with matching updates in sdk/next/release-family.mdx and sdk/next/security/security-policy.mdx.\n- Added the required branch work log entry in work-log/docs-chore-single-source-release-family-policy.md. |
| Cosmos Labs supports up to two release families at a time. For full lifecycle and retirement details, see the [Security and Maintenance Policy](/sdk/latest/security/security-policy). | ||
| Cosmos Labs supports up to two release families at a time. | ||
|
|
||
| Release cadence targets two new release families per year. If a planned successor family is delayed, the most recent supported family remains active until its successor is formally released. |
There was a problem hiding this comment.
Release cadence targets two new release families per year
should we be saying this? I dont think this is necessarily true (we are trying to do more smaller releases as part of our maintainability goal) and this feels unnecessary to call out.
Summary
sdk/latest/release-familythe canonical source for lifecycle/support window policy.sdk/latest/security/security-policyand replace with explicit pointer text.Test plan
/sdk/latest/release-familyand/sdk/latest/security/security-policyas intended.Made with Cursor