Skip to content

RELEASE.md: update for the latest workflow - #2060

Merged
eguzki merged 2 commits into
mainfrom
enhance-release-doc
Jun 23, 2026
Merged

RELEASE.md: update for the latest workflow#2060
eguzki merged 2 commits into
mainfrom
enhance-release-doc

Conversation

@eguzki

@eguzki eguzki commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Substantially restructured end-to-end release process documentation for improved clarity of RC and GA workflows.
    • Enhanced with explicit branch naming patterns, approval requirements, and verification steps for each release phase.
    • Updated dependency tracking documentation and community operator index catalog publishing with refined step-by-step guidance.

Signed-off-by: Eguzki Astiz Lezaun <eastizle@redhat.com>
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@eguzki, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 20 minutes and 39 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 313afad2-1ece-47d1-88be-d2c27bd21db9

📥 Commits

Reviewing files that changed from the base of the PR and between 1fddf7a and 4c25ef4.

📒 Files selected for processing (1)
  • RELEASE.md
📝 Walkthrough

Walkthrough

RELEASE.md is substantially rewritten to restructure the end-to-end release process. The document gains an Overview section, reorganised RC/GA and RC2+ workflow steps with Automated vs Manual distinctions, a dedicated Kuadrant Operator Dependencies checklist, a new Verify OLM Deployment subsection, and a minor wording correction in the community operator catalog instructions.

Changes

Release process documentation update

Layer / File(s) Summary
RC/GA workflow overview and step-by-step instructions
RELEASE.md
Adds an Overview describing the RC PR → GA PR sequence with branch naming, approval requirements, and triggers. Rewrites RC creation into Automated vs Manual (local/remote) workflows. Rewrites GA promotion with QE approval, post-merge verification, and RC2+ cherry-pick/update instructions.
Dependencies checklist and OLM verification steps
RELEASE.md
Replaces prose about olm/dependencies with a "Kuadrant Operator Dependencies" heading and bullet checklist. Rewrites the Verification section to introduce a "Verify OLM Deployment" subsection with a simplified first deployment step.
Community operator catalog bundle path wording fix
RELEASE.md
Adjusts a single parenthetical instruction line describing the /bundle path removal in the community operator index catalog section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 The release notes once tangled like vines,
Now sorted in neat little lines.
RC first, then the GA,
QE signs off — hip hooray!
The rabbit hops on, the docs now shine. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating RELEASE.md documentation for the latest workflow, which is the primary focus of this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch enhance-release-doc

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@RELEASE.md`:
- Around line 79-109: The markdown heading hierarchy in the "Promoting a Release
Candidate to GA" section is incorrect. The parent section uses ## (h2), but the
subsections "Local steps" and "Remote steps" currently use #### (h4). Fix the
heading hierarchy by changing both "#### Local steps" and "#### Remote steps" to
### (h3) to maintain proper nesting structure where each subsection heading
increments by exactly one level from its parent.
- Around line 168-169: The documentation link in RELEASE.md on line 168 points
to an incorrect file path. Update the link reference from
`/doc/development.md#deploy-kuadrant-operator-using-olm` to
`/doc/overviews/development.md#deploy-kuadrant-operator-using-olm` to correctly
point to the development.md file located in the overviews subdirectory where the
"Deploy kuadrant operator using OLM" section exists.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 90091e4d-685f-4b52-a43f-5d448cfeaa7b

📥 Commits

Reviewing files that changed from the base of the PR and between 5edef44 and 1fddf7a.

📒 Files selected for processing (1)
  • RELEASE.md

Comment thread RELEASE.md
Comment thread RELEASE.md Outdated
Signed-off-by: Eguzki Astiz Lezaun <eastizle@redhat.com>

@Boomatang Boomatang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

It will need a rework when Kuadrant/architecture#178 is implemented, but that is for a different day.

@eguzki
eguzki added this pull request to the merge queue Jun 23, 2026
Merged via the queue into main with commit 75f3f56 Jun 23, 2026
37 checks passed
@eguzki
eguzki deleted the enhance-release-doc branch June 23, 2026 14:24
@github-project-automation github-project-automation Bot moved this to Done in Kuadrant Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants