[hotfix] docs(lerian-notification): add v1.0 upgrade guide#1382
Open
gandalf-at-lerian wants to merge 1 commit into
Open
[hotfix] docs(lerian-notification): add v1.0 upgrade guide#1382gandalf-at-lerian wants to merge 1 commit into
gandalf-at-lerian wants to merge 1 commit into
Conversation
WalkthroughThis PR adds upgrade documentation for the lerian-notification Helm chart, guiding users from version 0.1.0 to 1.0.0-beta.3. The guide includes configuration changes, affected templates, breaking changes, and step-by-step migration instructions with example Helm commands. ChangesHelm 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: 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/lerian-notification/docs/UPGRADE-1.0.md`:
- Around line 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.
- 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.
🪄 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: 9982c7b7-f5d8-447c-84e1-6e63b21ed294
📒 Files selected for processing (1)
charts/lerian-notification/docs/UPGRADE-1.0.md
| @@ -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)** | |||
There was a problem hiding this comment.
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.
Comment on lines
+39
to
+41
| ### 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.
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.
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