[hotfix] docs(matcher): add v2.3 upgrade guide#1383
Open
gandalf-at-lerian wants to merge 1 commit into
Open
Conversation
Requested-by: @guimoreirar
WalkthroughAdds structured upgrade documentation for the matcher Helm chart covering the migration from version 2.2.0 to 2.3.0-beta.2, including configuration change review, template modifications, step-by-step migration instructions, and example Helm commands. ChangesMatcher Chart Upgrade Guide
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: 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
| @@ -0,0 +1,68 @@ | |||
| # Helm Upgrade from v2.2.x to v2.3.x | |||
| ## Topics | |||
| - **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** | |||
There was a problem hiding this comment.
Fix markdown formatting for the table of contents.
The topics list is concatenated into a single line without proper line breaks, making it difficult to read. Each topic should be on a separate line.
📝 Proposed fix for proper markdown formatting
-## Topics
-- **[Overview](`#overview`)**- **[Version changes](`#version-changes`)**- **[Configuration changes](`#configuration-changes`)**- **[Template changes](`#template-changes`)**- **[Migration steps](`#migration-steps`)**- **[Preview changes before upgrading](`#preview-changes-before-upgrading`)**- **[Command to upgrade](`#command-to-upgrade`)**
+## Topics
+- **[Overview](`#overview`)**
+- **[Version changes](`#version-changes`)**
+- **[Configuration changes](`#configuration-changes`)**
+- **[Template changes](`#template-changes`)**
+- **[Migration steps](`#migration-steps`)**
+- **[Preview changes before upgrading](`#preview-changes-before-upgrading`)**
+- **[Command to upgrade](`#command-to-upgrade`)**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Template changes](#template-changes)**- **[Migration steps](#migration-steps)**- **[Preview changes before upgrading](#preview-changes-before-upgrading)**- **[Command to upgrade](#command-to-upgrade)** | |
| ## Topics | |
| - **[Overview](`#overview`)** | |
| - **[Version changes](`#version-changes`)** | |
| - **[Configuration changes](`#configuration-changes`)** | |
| - **[Template changes](`#template-changes`)** | |
| - **[Migration steps](`#migration-steps`)** | |
| - **[Preview changes before upgrading](`#preview-changes-before-upgrading`)** | |
| - **[Command to upgrade](`#command-to-upgrade`)** |
🤖 Prompt for 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.
In `@charts/matcher/docs/UPGRADE-2.3.md` at 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.
Comment on lines
+47
to
+52
| ## Migration steps | ||
|
|
||
| 1. Read this guide and compare your custom values against `charts/matcher/values.yaml`. | ||
| 2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. | ||
| 3. Render the chart locally with your production values and review the manifest diff. | ||
| 4. Apply the upgrade in a controlled environment before production. |
There was a problem hiding this comment.
Resolve inconsistency between migration steps and stated changes.
Step 2 instructs users to "Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings," but the Configuration changes section explicitly states "No direct values.yaml key changes detected" (lines 21, 25) and "No image, env, secret, probe, ingress, service, port, or enablement changes detected" (line 29).
This contradictory guidance will confuse users about whether they need to add new values or not.
📋 Proposed fix to align migration steps with actual changes
## Migration steps
1. Read this guide and compare your custom values against `charts/matcher/values.yaml`.
-2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings.
-3. Render the chart locally with your production values and review the manifest diff.
+2. Render the chart locally with your production values and review the manifest diff.
+3. Verify that the template changes in `deployment.yaml` are compatible with your environment.
4. Apply the upgrade in a controlled environment before production.🤖 Prompt for 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.
In `@charts/matcher/docs/UPGRADE-2.3.md` around lines 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.
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
1 participant
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.
Summary
Requested by: @guimoreirar