Skip to content

[hotfix] docs(lerian-notification): add v1.0 upgrade guide #1382

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(lerian-notification): add v1.0 upgrade guide #1382

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
88 changes: 88 additions & 0 deletions charts/lerian-notification/docs/UPGRADE-1.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Helm Upgrade from v0.x to v1.x
## Topics
- **[Overview](#overview)**- **[Version changes](#version-changes)**- **[Configuration changes](#configuration-changes)**- **[Breaking changes to review](#breaking-changes-to-review)**- **[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 the Topics list markdown formatting.

The links are concatenated into a single bullet, which breaks readability and navigation.

Proposed fix 
- - **[Overview](`#overview`)**- **[Version changes](`#version-changes`)**- **[Configuration changes](`#configuration-changes`)**- **[Breaking changes to review](`#breaking-changes-to-review`)**- **[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`)**
+ - **[Breaking changes to review](`#breaking-changes-to-review`)**
+ - **[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)**- **[Breaking changes to review](#breaking-changes-to-review)**- **[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`)**
- **[Breaking changes to review](`#breaking-changes-to-review`)**
- **[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/lerian-notification/docs/UPGRADE-1.0.md` at line 3, The single-line
Topics list in UPGRADE-1.0.md is concatenating multiple links into one bullet;
split that long line into separate list items so each link gets its own bullet
(e.g., replace the combined string "**[Overview](`#overview`)**- **[Version
changes](`#version-changes`)**..." with separate lines like "-
**[Overview](`#overview`)**", "- **[Version changes](`#version-changes`)**", etc.)
to restore proper markdown list formatting and readability.


## Overview
This guide covers the `lerian-notification` chart upgrade from `0.1.0` to `1.0.0-beta.3`. It was generated retroactively from the chart history and focuses on major version changes; patch-only releases are intentionally ignored.

Because this is a major upgrade, review all removed values, renamed templates, and changed defaults before applying it to production.

## Version changes

| Field | Previous | Current |
|-------|----------|---------|
| Chart version | `0.1.0` | `1.0.0-beta.3` |
| App version | `0.1.0` | `0.1.0` |

## Configuration changes

### Added values

```yaml
api.securityContext.allowPrivilegeEscalation: false
api.securityContext.seccompProfile.type: "RuntimeDefault"
migrations.securityContext.allowPrivilegeEscalation: false
migrations.securityContext.seccompProfile.type: "RuntimeDefault"
secrets.DATABASE_URL: ""
workerEmail.securityContext.allowPrivilegeEscalation: false
workerEmail.securityContext.seccompProfile.type: "RuntimeDefault"
workerSms.securityContext.allowPrivilegeEscalation: false
workerSms.securityContext.seccompProfile.type: "RuntimeDefault"
workerWebhook.securityContext.allowPrivilegeEscalation: false
workerWebhook.securityContext.seccompProfile.type: "RuntimeDefault"
```

### 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 +39 to +41
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

Resolve contradiction in secret-change guidance.

This section says no secret changes were detected, but secrets.DATABASE_URL is explicitly listed as a new value above. That inconsistency can confuse upgrade execution.

Proposed fix 
- _No image, env, secret, probe, ingress, service, port, or enablement changes detected in values.yaml._
+ _No image, env, probe, ingress, service, port, or enablement changes detected in values.yaml beyond the added keys listed above (including `secrets.DATABASE_URL`)._
🤖 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/lerian-notification/docs/UPGRADE-1.0.md` around lines 39 - 41, The
"Changed operational values" section contradicts the values list because
secrets.DATABASE_URL is newly added; update the upgrade notes so they are
consistent by either removing secrets.DATABASE_URL from the earlier "new values"
list or by updating the "Changed operational values" paragraph to mention that
secrets.DATABASE_URL was added and requires operator attention (e.g., provide
guidance to set the new secret); locate references to "secrets.DATABASE_URL" and
the "Changed operational values" heading and make the text consistent.


## Breaking changes to review

No removed values were detected in `values.yaml`, but this is still a major chart version. Review the template changes below before rollout.

## Template changes

### Added files

- No chart files added.

### Removed files

- No chart files removed.

### Modified files

- `charts/lerian-notification/Chart.yaml`
- `charts/lerian-notification/templates/api/hpa.yaml`
- `charts/lerian-notification/templates/api/pdb.yaml`
- `charts/lerian-notification/templates/configmap.yaml`
- `charts/lerian-notification/templates/migrations-job.yaml`
- `charts/lerian-notification/templates/secret.yaml`
- `charts/lerian-notification/values.yaml`

## Migration steps

1. Read this guide and compare your custom values against `charts/lerian-notification/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.

## Preview changes before upgrading

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

## Command to upgrade

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