docs: add release and support process page#553
Merged
chalindukodikara merged 2 commits intoopenchoreo:mainfrom Apr 11, 2026
Merged
docs: add release and support process page#553chalindukodikara merged 2 commits intoopenchoreo:mainfrom
chalindukodikara merged 2 commits intoopenchoreo:mainfrom
Conversation
Signed-off-by: tishan89 <dtishanpubudu@gmail.com>
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughA new documentation page defines OpenChoreo's release lifecycle, semantic versioning, release cadence (including hotfix pre-releases), release status categories (Actively Supported, Maintenance Mode, EOL), supported-minor rules (latest three minor lines), and upgrade guidance. The sidebar is updated to surface this new Releases doc. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@sidebars.ts`:
- Around line 662-666: The new top-level sidebar entry with id
'releases/release-and-support-process' and label 'Releases' must be moved under
the existing "Contributor Guide" section rather than added as a separate
top-level item; locate the 'Contributor Guide' sidebar object in sidebars.ts and
insert the { type: 'doc', id: 'releases/release-and-support-process', label:
'Releases' } entry into its items array (maintaining the mandated sidebar
sequence so it appears before the "FAQ" section) and remove the standalone
top-level object.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 77dc2dc7-1077-45d1-9dc4-0d507adcad1b
📒 Files selected for processing (2)
docs/releases/release-and-support-process.mdsidebars.ts
Comment on lines
+662
to
+666
| { | ||
| type: 'doc', | ||
| id: 'releases/release-and-support-process', | ||
| label: 'Releases', | ||
| }, |
Contributor
There was a problem hiding this comment.
Move “Releases” under an allowed section instead of adding a new top-level section.
This introduces a new top-level sidebar entry that is not part of the required sidebar order. Please place this page under an existing allowed section (most appropriately Contributor Guide) and keep the mandated sequence intact.
As per coding guidelines: “sidebars.ts: Sidebar structure must follow this order: … 9. Contributor Guide 10. FAQ. Flag if new entries are added to the wrong section.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@sidebars.ts` around lines 662 - 666, The new top-level sidebar entry with id
'releases/release-and-support-process' and label 'Releases' must be moved under
the existing "Contributor Guide" section rather than added as a separate
top-level item; locate the 'Contributor Guide' sidebar object in sidebars.ts and
insert the { type: 'doc', id: 'releases/release-and-support-process', label:
'Releases' } entry into its items array (maintaining the mandated sidebar
sequence so it appears before the "FAQ" section) and remove the standalone
top-level object.
yashodgayashan
previously approved these changes
Apr 11, 2026
Signed-off-by: tishan89 <dtishanpubudu@gmail.com>
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/releases/release-and-support-process.md (1)
47-47: Consider clarifying the hotfix notation.Minor terminology and clarity suggestions:
- "suffixed" is more commonly used than "postfixed" in versioning contexts
- Consider clarifying what
nrepresents in-hotfix.n(e.g., "a sequential number")✏️ Proposed refinement
-Patch releases are normally published on a **monthly** cadence. The earliest patch releases after a new minor release may happen faster. Additional out-of-band patch pre-releases (postfixed with `-hotfix.n`) may be published when required to address critical issues. Support for these pre-releases will end once the next patch release is released. +Patch releases are normally published on a **monthly** cadence. The earliest patch releases after a new minor release may happen faster. Additional out-of-band patch pre-releases (suffixed with `-hotfix.n`, where `n` is a sequential number) may be published when required to address critical issues. Support for these pre-releases will end once the next patch release is released.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/releases/release-and-support-process.md` at line 47, Update the sentence describing hotfix pre-releases to use "suffixed" instead of "postfixed" and explicitly clarify the meaning of `n` in the `-hotfix.n` notation (e.g., "n is a sequential number indicating the hotfix iteration"); locate the paragraph that mentions `-hotfix.n` and "postfixed" and replace those terms and add the brief parenthetical explanation so the notation reads clearly for readers.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/releases/release-and-support-process.md`:
- Line 47: Update the sentence describing hotfix pre-releases to use "suffixed"
instead of "postfixed" and explicitly clarify the meaning of `n` in the
`-hotfix.n` notation (e.g., "n is a sequential number indicating the hotfix
iteration"); locate the paragraph that mentions `-hotfix.n` and "postfixed" and
replace those terms and add the brief parenthetical explanation so the notation
reads clearly for readers.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 9cdbd1f8-13ac-4692-b051-71a022b366ec
📒 Files selected for processing (1)
docs/releases/release-and-support-process.md
yashodgayashan
approved these changes
Apr 11, 2026
chalindukodikara
approved these changes
Apr 11, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Purpose
Adds the OC release process documentation
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors