[DOCs] Add release process documentation#2288
Merged
KaveeshaPiumini merged 1 commit intoasgardeo:mainfrom Apr 29, 2026
Merged
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdded a new Release Operations entry to the contribution overview and created a new release-process documentation page that defines Thunder’s weekly release cadence, branching model, validation requirements, Release Manager responsibilities, issue decision table, and related GitHub Actions workflows. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 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}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/content/community/contributing/release-process.mdx (1)
38-38: Resolve Vale wording warnings on release validation text.Both warnings are on changed lines; small wording edits will clear lint noise.
Proposed wording cleanup
-Development happens continuously on `main`. On Thursday night, a `release` branch is cut from `main`. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, it is tagged and the branch is merged back into `main` and deleted. +Development happens continuously on `main`. On Thursday night, a `release` branch is cut from `main`. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and confirmed good, the release is tagged, merged back into `main`, and the branch is deleted. -In addition to milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases. +Along with milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases.Also applies to: 46-46
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/community/contributing/release-process.mdx` at line 38, The release validation paragraph wording triggers Vale lint warnings; update the sentence about cutting a `release` branch and applying fixes so it uses clearer, more neutral language (e.g., replace "On Thursday night, a `release` branch is cut from `main`. Any fixes identified during release validation are applied directly to the release branch." with a concise version like "A `release` branch is created from `main` on Thursday evening; any fixes found during release validation are applied to that release branch."), and make the same small wording adjustment at the second occurrence around the corresponding line (the release-validation text referenced in the diff) to clear the lint warnings while preserving the described workflow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/content/community/contributing/overview.mdx`:
- Line 27: Update the local link for "Release process" to use an explicit .mdx
filename; replace the link text `[Release process](release-process)` in the
table row `| **Release Operations** | [Release process](release-process) |` with
`[Release process](release-process.mdx)` so it matches other local links like
`development.md` and `problem-definition.md`.
---
Nitpick comments:
In `@docs/content/community/contributing/release-process.mdx`:
- Line 38: The release validation paragraph wording triggers Vale lint warnings;
update the sentence about cutting a `release` branch and applying fixes so it
uses clearer, more neutral language (e.g., replace "On Thursday night, a
`release` branch is cut from `main`. Any fixes identified during release
validation are applied directly to the release branch." with a concise version
like "A `release` branch is created from `main` on Thursday evening; any fixes
found during release validation are applied to that release branch."), and make
the same small wording adjustment at the second occurrence around the
corresponding line (the release-validation text referenced in the diff) to clear
the lint warnings while preserving the described workflow.
🪄 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: ded2d0ce-0fe3-4d5e-9e22-b5ca7e91fdb4
📒 Files selected for processing (2)
docs/content/community/contributing/overview.mdxdocs/content/community/contributing/release-process.mdx
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2288 +/- ##
==========================================
+ Coverage 88.18% 88.19% +0.01%
==========================================
Files 881 881
Lines 61186 61186
==========================================
+ Hits 53956 53963 +7
+ Misses 5377 5369 -8
- Partials 1853 1854 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
KaveeshaPiumini
force-pushed
the
configdb
branch
from
02c8be5 to
0bf8640
Compare
KaveeshaPiumini
added
Type/Docs
skip-changelog
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 `@docs/content/community/contributing/release-process.mdx`:
- Line 38: Replace the flagged vague phrases "it is" and "In addition" with
tighter wording in the release-process doc: update the sentence containing "Any
fixes identified during release validation are applied directly to the release
branch. Once everything is validated and the release is confirmed good, it is
tagged..." to use "we tag the release" or "the release is then tagged" and
change the sentence starting with "In addition" to a more direct construction
such as "Additionally," or rephrase to start with the specific subject; ensure
both replacements appear where the exact strings "it is" and "In addition" occur
so Vale warnings are resolved.
🪄 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: 010d2ba9-1882-4f38-9317-a355c275ab74
📒 Files selected for processing (2)
docs/content/community/contributing/overview.mdxdocs/content/community/contributing/release-process.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/content/community/contributing/overview.mdx
KaveeshaPiumini
force-pushed
the
configdb
branch
from
0bf8640 to
0baeb1c
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/content/community/contributing/release-process.mdx (1)
38-38:⚠️ Potential issue | 🟡 MinorResolve the remaining Vale wording warnings on Line 38 and Line 54.
Both phrases are still flagged by the latest Vale run (
it is,In addition), so this doc will keep warning until they’re tightened.Suggested wording patch
-Development happens continuously on `main`. On Thursday night, the Pre-Release Sync merges the latest changes from `main` into `release` branch. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, it is tagged and merged back into `main` automatically. +Development happens continuously on `main`. On Thursday night, the Pre-Release Sync merges the latest changes from `main` into the `release` branch. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, the release is tagged and merged back into `main` automatically. -In addition to milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases. +Additionally, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases.Based on learnings: "Only respond to the latest Vale check run when Vale feedback is provided through CI checks; ignore resolved or outdated annotations from previous commits."
Also applies to: 54-54
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/community/contributing/release-process.mdx` at line 38, Replace the Vale-flagged wording by removing the flagged phrases: change "it is tagged and merged back into `main` automatically." to a clearer active phrase such as "the release is tagged and merged back into `main` automatically." (avoid using "it is"); and replace any "In addition" occurrences with a tighter alternative like "Also" or "Additionally," to satisfy Vale; update the sentences containing "Pre-Release Sync merges the latest changes from `main` into `release` branch" and the subsequent release-summary sentence to use these replacements so the doc no longer includes the flagged "it is" and "In addition" phrases.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/content/community/contributing/release-process.mdx`:
- Line 38: Replace the Vale-flagged wording by removing the flagged phrases:
change "it is tagged and merged back into `main` automatically." to a clearer
active phrase such as "the release is tagged and merged back into `main`
automatically." (avoid using "it is"); and replace any "In addition" occurrences
with a tighter alternative like "Also" or "Additionally," to satisfy Vale;
update the sentences containing "Pre-Release Sync merges the latest changes from
`main` into `release` branch" and the subsequent release-summary sentence to use
these replacements so the doc no longer includes the flagged "it is" and "In
addition" phrases.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 1c713df8-9e76-45da-a0d6-5cde007f9e09
📒 Files selected for processing (3)
.github/workflows/post-release-sync.ymldocs/content/community/contributing/overview.mdxdocs/content/community/contributing/release-process.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/content/community/contributing/overview.mdx
KaveeshaPiumini
force-pushed
the
configdb
branch
from
0baeb1c to
bea25f0
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/content/community/contributing/release-process.mdx (2)
54-54:⚠️ Potential issue | 🟡 MinorResolve Vale wording warning on Line 54 (
In addition).This wording is also flagged by the latest Vale run; rephrase to a shorter transition.
Based on learnings: “Run Vale locally and resolve all warnings before finalizing documentation output.”Suggested wording patch
-In addition to milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases. +Besides milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/community/contributing/release-process.mdx` at line 54, Reword the transition sentence starting with "In addition to milestone-specific changes" on the line that mentions "core IAM flows" to a shorter, clearer transition to satisfy Vale (e.g., replace with "Regardless of scope, core IAM flows — authentication, authorization, and token management — are tested every release."), update the sentence that references "core IAM flows" accordingly, and run Vale locally to confirm the warning is resolved before committing.
38-38:⚠️ Potential issue | 🟡 MinorResolve Vale wording warning on Line 38 (
it is).This phrase is currently blocking doc lint; replace with tighter wording.
Based on learnings: “Only respond to the latest Vale check run when Vale feedback is provided through CI checks.”Suggested wording patch
-Development happens continuously on `main`. On Thursday night, the Pre-Release Sync merges the latest changes from `main` into `release` branch. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, it is tagged and merged back into `main` automatically. +Development happens continuously on `main`. On Thursday night, the Pre-Release Sync merges the latest changes from `main` into `release` branch. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, the release is tagged and merged back into `main` automatically.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/community/contributing/release-process.mdx` at line 38, The phrase "it is tagged and merged back into `main` automatically" triggers Vale; update the sentence in the release process paragraph to tighter active wording—replace the passive "it is tagged and merged back into `main` automatically" with an active form such as "we tag the release and automatically merge it back into `main`" so the line in docs/content/community/contributing/release-process.mdx no longer uses the problematic "it is" phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/content/community/contributing/release-process.mdx`:
- Line 54: Reword the transition sentence starting with "In addition to
milestone-specific changes" on the line that mentions "core IAM flows" to a
shorter, clearer transition to satisfy Vale (e.g., replace with "Regardless of
scope, core IAM flows — authentication, authorization, and token management —
are tested every release."), update the sentence that references "core IAM
flows" accordingly, and run Vale locally to confirm the warning is resolved
before committing.
- Line 38: The phrase "it is tagged and merged back into `main` automatically"
triggers Vale; update the sentence in the release process paragraph to tighter
active wording—replace the passive "it is tagged and merged back into `main`
automatically" with an active form such as "we tag the release and automatically
merge it back into `main`" so the line in
docs/content/community/contributing/release-process.mdx no longer uses the
problematic "it is" phrasing.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 7ff3982b-c7ec-4073-9e8e-736427b7c682
📒 Files selected for processing (2)
docs/content/community/contributing/overview.mdxdocs/content/community/contributing/release-process.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/content/community/contributing/overview.mdx
KaveeshaPiumini
force-pushed
the
configdb
branch
from
bea25f0 to
20d2355
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/content/community/contributing/release-process.mdx (1)
38-38:⚠️ Potential issue | 🟡 MinorAddress the remaining Vale wording warnings.
Two wording patterns still fail lint:
it is(Line 38) andIn addition(Line 54). Please tighten both phrases to clear the docs pipeline.Suggested wording patch
-Development happens continuously on `main`. On Thursday night, the Pre-Release Sync merges the latest changes from `main` into `release` branch. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, it is tagged and merged back into `main` automatically. +Development happens continuously on `main`. On Thursday night, the Pre-Release Sync merges the latest changes from `main` into `release` branch. Any fixes identified during release validation are applied directly to the release branch. Once everything is validated and the release is confirmed good, the release is tagged and merged back into `main` automatically. -In addition to milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases. +Besides milestone-specific changes, **core IAM flows** — including authentication, authorization, and token management — are tested every release, regardless of what changed. This ensures baseline functionality is never silently broken between releases.As per coding guidelines
docs/**: ensure documentation consistency and quality in changed docs.Also applies to: 54-54
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/community/contributing/release-process.mdx` at line 38, Replace the flagged weak-phrase instances: change the clause "Once everything is validated and the release is confirmed good, it is tagged and merged back into `main` automatically." inside the release workflow sentence to a tighter phrasing such as "Once validated and confirmed good, tag and merge the release back into `main` automatically." and replace the "In addition" occurrence (line 54) with a tighter alternative like "Also" or "Additionally," to satisfy Vale wording rules; update the two exact phrases in the sentence containing "it is tagged and merged back into `main` automatically" and the sentence starting with "In addition" accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/content/community/contributing/release-process.mdx`:
- Line 38: Replace the flagged weak-phrase instances: change the clause "Once
everything is validated and the release is confirmed good, it is tagged and
merged back into `main` automatically." inside the release workflow sentence to
a tighter phrasing such as "Once validated and confirmed good, tag and merge the
release back into `main` automatically." and replace the "In addition"
occurrence (line 54) with a tighter alternative like "Also" or "Additionally,"
to satisfy Vale wording rules; update the two exact phrases in the sentence
containing "it is tagged and merged back into `main` automatically" and the
sentence starting with "In addition" accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 63d0d857-a1c5-47cd-89ea-9c431c59e3a6
📒 Files selected for processing (2)
docs/content/community/contributing/overview.mdxdocs/content/community/contributing/release-process.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/content/community/contributing/overview.mdx
KaveeshaPiumini
force-pushed
the
configdb
branch
3 times, most recently
from
26e37ac to
36fe226
Compare
senthalan
reviewed
Apr 28, 2026
KaveeshaPiumini
force-pushed
the
configdb
branch
2 times, most recently
from
5f1f6c9 to
c6f76e2
Compare
KaveeshaPiumini
force-pushed
the
configdb
branch
from
c6f76e2 to
e0bc9a2
Compare
rajithacharith
approved these changes
Apr 29, 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
This pull request introduces documentation for Thunder's release process and updates the contribution overview to include release operations as a recognized area of contribution. The main focus is to clarify and formalize how weekly releases are planned, validated, and executed, providing clear guidance for contributors and release managers.
Documentation updates:
release-process.mdxpage detailing the weekly release cadence, branch model, validation requirements, release manager responsibilities, issue handling, and automation workflows.overview.mdxto include "Release Operations" with a link to the new release process documentation.Related Issues
Related PRs
Checklist
breaking changelabel added.Security checks
Summary by CodeRabbit