docs(matcher): add v2.3 upgrade guide#1383
Conversation
Requested-by: @guimoreirar
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdds 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. ChangesMatcher Chart Upgrade Guide
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
charts/matcher/docs/UPGRADE-2.3.md
Requested-by: @guimoreirar
Summary
Requested by: @guimoreirar