Skip to content

[hotfix] docs(fetcher): add v2.2 upgrade guide #1380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gandalf-at-lerian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[hotfix] docs(fetcher): add v2.2 upgrade guide #1380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions charts/fetcher/docs/UPGRADE-2.2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)**
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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).


## Overview
This guide covers the `fetcher` chart upgrade from `2.1.1` to `2.2.0-beta.4`. It was generated retroactively from the chart history and focuses on minor version changes; patch-only releases are intentionally ignored.

Because this is a minor upgrade, the expected path is an in-place Helm upgrade after reviewing new values and changed defaults.

## Version changes

| Field | Previous | Current |
|-------|----------|---------|
| Chart version | `2.1.1` | `2.2.0-beta.4` |
| App version | `1.3.0` | `1.3.0` |

## Configuration changes

### Added values

_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._
Comment on lines +21 to +29
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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:

  1. Documenting what changed in the deployment.yaml and whether it affects user-configurable values, or
  2. 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.


## Template changes

### Added files

- No chart files added.

### Removed files

- No chart files removed.

### Modified files

- `charts/fetcher/CHANGELOG.md`
- `charts/fetcher/Chart.yaml`
- `charts/fetcher/templates/manager/deployment.yaml`

## 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.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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.

3. Render the chart locally with your production values and review the manifest diff.
4. Apply the upgrade in a controlled environment before production.

## Preview changes before upgrading

```bash
helm diff upgrade fetcher ./charts/fetcher \
--namespace <namespace> \
--values <your-values.yaml>
```

## Command to upgrade

```bash
helm upgrade fetcher ./charts/fetcher \
--namespace <namespace> \
--values <your-values.yaml>
```
Loading