Skip to content

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

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(matcher): add v2.3 upgrade guide #1383

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/matcher/docs/UPGRADE-2.3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)**
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 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.


## Overview
This guide covers the `matcher` chart upgrade from `2.2.0` to `2.3.0-beta.2`. 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.2.0` | `2.3.0-beta.2` |
| App version | `1.0.0` | `1.0.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._

## Template changes

### Added files

- No chart files added.

### Removed files

- No chart files removed.

### Modified files

- `charts/matcher/Chart.yaml`
- `charts/matcher/templates/deployment.yaml`
- `charts/matcher/values.yaml`

## 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.
Comment on lines +47 to +52
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 | 🟠 Major | ⚡ Quick win

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.


## Preview changes before upgrading

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

## Command to upgrade

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