[hotfix] docs(fetcher): add v2.2 upgrade guide#1380
Open
gandalf-at-lerian wants to merge 1 commit into
Open
Conversation
Requested-by: @guimoreirar
WalkthroughThis PR adds a new upgrade documentation file for the fetcher Helm chart. The guide provides users with a clear path to upgrade from version 2.1.1 to 2.2.0-beta.4, documenting version changes, configuration updates, affected templates, migration steps, and Helm commands. ChangesFetcher Chart Upgrade Documentation
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: 3
🤖 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/fetcher/docs/UPGRADE-2.2.md`:
- Around line 21-29: Update the UPGRADE-2.2.md to reconcile the “no changes
detected” statements with the modified template: either (A) add a short summary
of what changed in templates/manager/deployment.yaml (e.g., field names, default
settings, image/probe/service tweaks) and note whether those are
user-configurable or impact upgrades, referencing
"templates/manager/deployment.yaml"; or (B) explicitly state that the deployment
template was modified for internal/template-only reasons but that no user-facing
values.yaml keys, images, envs, probes, services, ports, or enablement flags
were added/removed/changed, and link that clarification to the existing “No
direct values.yaml key changes detected” sections and the UPGRADE-2.2.md header.
Ensure the chosen clarification replaces the contradictory "no changes detected"
phrasing so readers understand the impact.
- Line 3: The TOC line in UPGRADE-2.2.md is concatenated into a single line;
split the items into a proper Markdown list by placing each entry on its own
line prefixed with a list marker (e.g., "- [Overview](`#overview`)"), ensuring
spacing and newlines between items so the TOC renders as a readable vertical
list (apply this change to the existing concatenated line that contains the
Overview/Version changes/Configuration changes/Template changes/Migration
steps/Preview changes before upgrading/Command to upgrade entries).
- Line 50: Remove or clarify the contradictory Step 2 in UPGRADE-2.2.md: the
step that says "Add any required new values..." conflicts with the
"Configuration changes" note stating "No image, env, secret, probe, ingress,
service, port, or enablement changes detected in values.yaml." Edit the Step 2
wording (or delete it) so it aligns with the Configuration changes section—e.g.,
change Step 2 to a verification step ("Verify there are no required changes to
secrets, configmaps, probes, ingress, or services; if you have custom overrides,
add them") or remove the instruction entirely to avoid implying required action.
🪄 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: 048fae4c-aa24-4309-8ce4-235b18662b63
📒 Files selected for processing (1)
charts/fetcher/docs/UPGRADE-2.2.md
| @@ -0,0 +1,68 @@ | |||
| # Helm Upgrade from v2.1.x to v2.2.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 TOC formatting for readability.
The table of contents items are concatenated on a single line without proper spacing or newlines. This makes the TOC difficult to read and doesn't render as a proper markdown list.
📝 Proposed fix for TOC formatting
-- **[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`)**
+- **[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)** | |
| - **[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/fetcher/docs/UPGRADE-2.2.md` at line 3, The TOC line in UPGRADE-2.2.md
is concatenated into a single line; split the items into a proper Markdown list
by placing each entry on its own line prefixed with a list marker (e.g., "-
[Overview](`#overview`)"), ensuring spacing and newlines between items so the TOC
renders as a readable vertical list (apply this change to the existing
concatenated line that contains the Overview/Version changes/Configuration
changes/Template changes/Migration steps/Preview changes before
upgrading/Command to upgrade entries).
Comment on lines
+21
to
+29
| _No direct values.yaml key changes detected._ | ||
|
|
||
| ### Removed values | ||
|
|
||
| _No direct values.yaml key changes detected._ | ||
|
|
||
| ### Changed operational values | ||
|
|
||
| _No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._ |
There was a problem hiding this comment.
Address inconsistency between "no changes detected" and modified template files.
The document states multiple times that no configuration changes were detected (lines 21, 25, 29), yet lists templates/manager/deployment.yaml as a modified file (line 45). Changes to deployment templates often involve configuration modifications that users need to review.
Additionally, the document doesn't explain what actually changed in the deployment.yaml file, which is critical information for users assessing the upgrade impact.
Consider either:
- Documenting what changed in the deployment.yaml and whether it affects user-configurable values, or
- Clarifying that while the template was modified, no user-facing configuration values were added/removed/changed
Also applies to: 43-45
🤖 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/fetcher/docs/UPGRADE-2.2.md` around lines 21 - 29, Update the
UPGRADE-2.2.md to reconcile the “no changes detected” statements with the
modified template: either (A) add a short summary of what changed in
templates/manager/deployment.yaml (e.g., field names, default settings,
image/probe/service tweaks) and note whether those are user-configurable or
impact upgrades, referencing "templates/manager/deployment.yaml"; or (B)
explicitly state that the deployment template was modified for
internal/template-only reasons but that no user-facing values.yaml keys, images,
envs, probes, services, ports, or enablement flags were added/removed/changed,
and link that clarification to the existing “No direct values.yaml key changes
detected” sections and the UPGRADE-2.2.md header. Ensure the chosen
clarification replaces the contradictory "no changes detected" phrasing so
readers understand the impact.
| ## Migration steps | ||
|
|
||
| 1. Read this guide and compare your custom values against `charts/fetcher/values.yaml`. | ||
| 2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. |
There was a problem hiding this comment.
Remove contradictory migration step.
Step 2 advises 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 image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml" (line 29).
This contradiction creates confusion about whether users need to take action.
📝 Proposed fix to align migration steps with documented changes
1. Read this guide and compare your custom values against `charts/fetcher/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.
+2. Render the chart locally with your production values and review the manifest diff.
+3. Apply the upgrade in a controlled environment before production.📝 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
| 2. Add any required new values for your environment, especially secrets, configmaps, probes, ingress, and service settings. | |
| 1. Read this guide and compare your custom values against `charts/fetcher/values.yaml`. | |
| 2. Render the chart locally with your production values and review the manifest diff. | |
| 3. 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/fetcher/docs/UPGRADE-2.2.md` at line 50, Remove or clarify the
contradictory Step 2 in UPGRADE-2.2.md: the step that says "Add any required new
values..." conflicts with the "Configuration changes" note stating "No image,
env, secret, probe, ingress, service, port, or enablement changes detected in
values.yaml." Edit the Step 2 wording (or delete it) so it aligns with the
Configuration changes section—e.g., change Step 2 to a verification step
("Verify there are no required changes to secrets, configmaps, probes, ingress,
or services; if you have custom overrides, add them") or remove the instruction
entirely to avoid implying required action.
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