Skip to content

chore(chart,docs): fix NOTES.txt ingress key + drop duplicate secrets block#890

Merged
buremba merged 1 commit into
mainfrom
chore/chart-notes-and-docs-polish
May 18, 2026
Merged

chore(chart,docs): fix NOTES.txt ingress key + drop duplicate secrets block#890
buremba merged 1 commit into
mainfrom
chore/chart-notes-and-docs-polish

Conversation

@buremba
Copy link
Copy Markdown
Member

@buremba buremba commented May 18, 2026

Summary

Two CodeRabbit follow-ups from PR #882:

  1. charts/lobu/templates/NOTES.txt referenced .Values.ingress.host (singular), but the chart's values schema uses .Values.ingress.hosts (array). Fresh installs rendered the install URL as https:// with an empty host. Now reads from index .Values.ingress.hosts 0 when both ingress.enabled is true and at least one host is set, falling through to the port-forward hint otherwise.

  2. packages/landing/.../kubernetes.mdx had the same kubectl create secret block twice. The second copy is removed and replaced with a back-reference to the earlier section.

Verification

```
$ helm install --dry-run --debug --generate-name charts/lobu \
--set ingress.enabled=true --set 'ingress.hosts={app.example.com}' | grep 'Application URL' -A 1
Application URL:
https://app.example.com

$ helm install --dry-run --debug --generate-name charts/lobu \
--set ingress.enabled=false | grep 'Application URL' -A 1
Application URL:
kubectl port-forward svc/lobu-...-app 8787:8787
```

Test plan

  • make build-packages clean
  • make typecheck clean
  • Helm renders correctly for both ingress.enabled=true and ingress.enabled=false

Summary by CodeRabbit

  • Documentation

    • Updated Kubernetes Helm deployment guide with clarified guidance on required Kubernetes Secrets handling during installation.
  • Improvements

    • Helm chart NOTES template now intelligently displays the application URL only when ingress is enabled and configured with valid hosts.

Review Change Stack

… block

Two CodeRabbit follow-ups from PR #882:

1. charts/lobu/templates/NOTES.txt referenced .Values.ingress.host
   (singular), but the chart's values schema uses .Values.ingress.hosts
   (array). Fresh installs rendered the install URL as
   `https://` with an empty host. Now reads from
   `index .Values.ingress.hosts 0` when both ingress.enabled and at
   least one host are set, falls through to the port-forward hint
   otherwise.

2. packages/landing/.../kubernetes.mdx had the same
   `kubectl create secret` block twice — once under "Create secrets"
   and again later under "Install". The second copy is removed and
   replaced with a back-reference to the earlier section, so users
   aren't told to do the same thing twice.

Verified by `helm install --dry-run --debug --generate-name` on both
ingress.enabled=true (renders https://app.example.com) and
ingress.enabled=false (renders port-forward).
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

The PR updates the Helm chart NOTES template to render ingress application URLs from a list of configured hosts rather than a single host value, and clarifies in the Kubernetes deployment documentation that required Secrets must pre-exist in the target namespace before chart installation.

Changes

Kubernetes Deployment Configuration

Layer / File(s) Summary
Helm NOTES ingress hosts rendering
charts/lobu/templates/NOTES.txt
The "Application URL" output now requires both ingress.enabled and a non-empty ingress.hosts list, selecting the first host entry to format the URL instead of using a single ingress.host value.
Kubernetes secret pre-existence requirements
packages/landing/src/content/docs/deployment/kubernetes.mdx
Deployment documentation now explicitly states that the lobu-db and lobu-secrets Kubernetes Secrets must already exist in the target namespace before chart installation, removing the prior inline instruction block for creating those secrets.

Possibly related PRs

  • lobu-ai/lobu#882: Directly modifies the same NOTES template ingress host handling logic that this PR updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A chart that hosts ingress with grace,
Selecting URLs from the list's first place,
Secrets pre-made, no dance required,
Kubernetes paths now clarified and fired,
Deploy with clarity, no surprises in sight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the two main changes: fixing the NOTES.txt ingress key reference and removing duplicate secrets documentation block.
Description check ✅ Passed The description includes a clear summary of both changes, verification steps with command outputs, and a comprehensive test plan covering the required checks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/chart-notes-and-docs-polish

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Comment @coderabbitai help to get the list of available commands and usage tips.

@buremba buremba merged commit 5ab6d14 into main May 18, 2026
24 of 25 checks passed
@buremba buremba deleted the chore/chart-notes-and-docs-polish branch May 18, 2026 18:49
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants