Skip to content

docs(matcher): add v2.3 upgrade guide#1383

Merged
guimoreirar merged 2 commits into
mainfrom
hotfix/matcher-upgrade-doc-2-3
May 29, 2026
Merged

docs(matcher): add v2.3 upgrade guide#1383
guimoreirar merged 2 commits into
mainfrom
hotfix/matcher-upgrade-doc-2-3

Conversation

@gandalf-at-lerian
Copy link
Copy Markdown
Contributor

Summary

  • Adds the retroactive minor upgrade guide for from to .
  • Patch-only upgrade docs remain ignored, per task scope.

Requested by: @guimoreirar

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 16, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 43ed15fa-9820-44c3-8f60-75d392f573b5

📥 Commits

Reviewing files that changed from the base of the PR and between c88fb45 and 4c81ebf.

📒 Files selected for processing (1)
  • charts/matcher/docs/UPGRADE-2.3.md

Walkthrough

Adds an upgrade guide for the matcher Helm chart documenting changes in 2.3.0-beta.2, including probe configurability, readiness path defaulting to /readyz, modified chart files, migration steps, verification commands, and example Helm commands.

Changes

Matcher Chart Upgrade Guide

Layer / File(s) Summary
Matcher chart upgrade documentation
charts/matcher/docs/UPGRADE-2.3.md
New upgrade guide documents the release of matcher chart 2.3.0-beta.2, covering probe configurability and readiness path default change, lists modified chart/templates/values files, and provides step-by-step migration and verification commands plus example helm diff upgrade and helm upgrade commands.

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

@gandalf-at-lerian gandalf-at-lerian marked this pull request as ready for review May 16, 2026 15:30
@gandalf-at-lerian gandalf-at-lerian requested a review from a team as a code owner May 16, 2026 15:30
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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 `@charts/matcher/docs/UPGRADE-2.3.md`:
- Around line 47-52: The migration guide's Step 2 in "Migration steps" conflicts
with the "Configuration changes" section which reports "No direct values.yaml
key changes detected"; update Step 2 in UPGRADE-2.3.md to remove or qualify the
advice to "Add any required new values..., especially secrets, configmaps,
probes, ingress, and service settings" — either remove the parenthetical list or
change it to conditional language (e.g., "If your environment requires new keys,
add them...") and add a short note referencing the "Configuration changes"
summary so readers know no values.yaml changes are required for this release
unless they have custom overrides.
- Line 3: The table of contents line is concatenated into one long string ("-
**[Overview](`#overview`)**- **[Version changes](`#version-changes`)**..."); split
it so each topic is on its own markdown line (e.g., "-
**[Overview](`#overview`)**" on one line, "- **[Version
changes](`#version-changes`)**" on the next, etc.) to restore proper TOC
formatting and readability, ensuring consistent leading hyphen and spacing for
each entry.
🪄 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: ASSERTIVE

Plan: Pro

Run ID: 5a35971a-f9c7-49ae-8fe6-1a7cb68becda

📥 Commits

Reviewing files that changed from the base of the PR and between 3766751 and c88fb45.

📒 Files selected for processing (1)
  • charts/matcher/docs/UPGRADE-2.3.md

Comment thread charts/matcher/docs/UPGRADE-2.3.md Outdated
Comment thread charts/matcher/docs/UPGRADE-2.3.md Outdated
@guimoreirar guimoreirar changed the title [hotfix] docs(matcher): add v2.3 upgrade guide docs(matcher): add v2.3 upgrade guide May 29, 2026
@guimoreirar guimoreirar merged commit 70f60ce into main May 29, 2026
3 of 4 checks passed
@guimoreirar guimoreirar deleted the hotfix/matcher-upgrade-doc-2-3 branch May 29, 2026 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants