chore(helm): replace README with helm-docs generated file to keep values in sync - #41842
Merged
Conversation
…output Add README.md.gotmpl template and backfill ## @PARAM / # -- / # @section annotations in values.yaml so helm-docs generates a sectioned values reference. The README is now a quick-start that links out to docs.appsmith.com for full installation guides and configuration details. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ections Add # -- and # @section -- annotations to all subchart pass-through values (redis, mongodb, postgresql, prometheus) and remaining unannotated values so every value appears in its correct category table instead of a catch-all "Other Values" section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Rename sections: "Appsmith configuration", "Workload configuration" - Move Appsmith config, global params, and workload config to top of values.yaml so they appear first in the generated README - Move PDB into workload configuration section - Drop Miscellaneous section (falls to Other Values) - Remove MongoDB Operator prose from README template - Simplify documentation links in template Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughCI renamed to "Helm Docs" installs pinned helm-docs v1.14.2 and enforces regenerated values.schema.json and README.md match committed files; adds ChangesHelm Documentation Automation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Replace helm-schema.yml with helm-docs.yml that validates both the values schema and the generated README are up to date when values.yaml changes. Installs helm-docs in CI and uses --dry-run to compare against the committed README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Pull the Appsmith description from the main repo README into the chart README template so the two stay in sync. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add agent instructions to deploy/helm/ so any session editing values.yaml knows to regenerate the schema and README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
wyattwalter
changed the title
wyattwalter
marked this pull request as ready for review
May 22, 2026 21:42
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
deploy/helm/README.md (1)
1-264:⚠️ Potential issue | 🟠 Major | ⚡ Quick winRegenerate and commit
README.mdfrom helm-docs output.CI is failing because
README.mdis out of date relative to current sources/template. Please runhelm-docs --sort-values-order fileindeploy/helmand commit the regenerated file.Based on learnings: Ensure derived files (
values.schema.jsonandREADME) are kept up to date withvalues.yaml, as enforced by CI workflow.github/workflows/helm-docs.yml.🤖 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 `@deploy/helm/README.md` around lines 1 - 264, CI fails because deploy/helm/README.md is out of date; run helm-docs to regenerate and commit the derived docs. In deploy/helm run the helm-docs command (helm-docs --sort-values-order . or as CI uses) to regenerate README.md (and update values.schema.json if your helm-docs config produces it) from values.yaml, verify changes, and commit the regenerated files so they match the expectations of the .github/workflows/helm-docs.yml CI check.
🤖 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 @.github/workflows/helm-docs.yml:
- Around line 39-45: The Install helm-docs step currently streams the tarball
from curl into tar and installs it without integrity checks; update the step
that sets HELM_DOCS_VERSION and downloads the release to first fetch
checksums.txt and checksums.txt.sig for v${HELM_DOCS_VERSION}, verify the
checksum file signature (e.g., with gpg using the maintainer's public key), then
validate the downloaded helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz
against checksums.txt (e.g., sha256sum) before extracting and moving to
/usr/local/bin to ensure artifact integrity and match the checksums.txt format
when parsing.
In `@deploy/helm/values.yaml`:
- Around line 1083-1118: The KEDA values block is missing "# `@section` -- ..."
annotations so its entries (e.g., keda.enabled, keda.pollingInterval,
keda.cooldownPeriod, keda.minReplicaCount, keda.maxReplicaCount,
keda.fallback.failureThreshold, keda.fallback.replicas, keda.triggers) won't be
grouped into the README; add an appropriate "# `@section` -- KEDA" (or similar
section name) comment line before the KEDA block and add matching "# `@section` --
..." comments for the autoupdate block referenced around lines 1125-1131 so each
new value has both the "# --" description and a "# `@section` --" annotation per
the values.yaml doc guideline.
---
Outside diff comments:
In `@deploy/helm/README.md`:
- Around line 1-264: CI fails because deploy/helm/README.md is out of date; run
helm-docs to regenerate and commit the derived docs. In deploy/helm run the
helm-docs command (helm-docs --sort-values-order . or as CI uses) to regenerate
README.md (and update values.schema.json if your helm-docs config produces it)
from values.yaml, verify changes, and commit the regenerated files so they match
the expectations of the .github/workflows/helm-docs.yml CI check.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8510236c-c95e-491f-9564-43163c8f1498
📒 Files selected for processing (5)
.github/workflows/helm-docs.ymldeploy/helm/AGENTS.mddeploy/helm/README.mddeploy/helm/README.md.gotmpldeploy/helm/values.yaml
|
This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected. |
Download the checksums.txt from the helm-docs release and verify the tarball integrity with sha256sum before extracting. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Pin actions/checkout and azure/setup-helm to their release commit SHAs instead of mutable version tags. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
subrata71
reviewed
Jun 1, 2026
| # @schema hidden: true | ||
| APPSMITH_KEYCLOAK_DB_PASSWORD: "" | ||
| # @schema hidden: true | ||
| APPSMITH_KEYCLOAK_DB_URL: "" |
Collaborator
There was a problem hiding this comment.
@wyattwalter I am not sure if APPSMITH_BASE_URL env var is supposed to be part of this. Just flagging this in case it's meant to be part of it.
Contributor
Author
There was a problem hiding this comment.
I'm trying to not change functionality as part of this. It's just brought over from what's current. Can follow up if it should be there.
salevine
previously approved these changes
Jun 1, 2026
salevine
left a comment
salevine
left a comment
Contributor
There was a problem hiding this comment.
With the recent change, looks good
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 @.github/workflows/helm-docs.yml:
- Around line 42-46: The downloaded checksum file and tarball must be fetched
with fail-fast HTTP handling and matching filenames: change curl to use -fSL for
both the checksums and tarball (so a 404/Not Found causes the step to fail),
preserve the asset filename instead of renaming to helm-docs.tar.gz (use
helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz), and run sha256sum --check
against checksums.txt (which now will contain the expected asset filename). Keep
the BASE_URL/HELM_DOCS_VERSION vars and ensure the tar extraction uses the same
asset filename (tar xzf helm-docs_${HELM_DOCS_VERSION}_Linux_x86_64.tar.gz
helm-docs) so verification and extraction align.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d79ddabe-685c-4c51-a064-8319d6a8224b
📒 Files selected for processing (1)
.github/workflows/helm-docs.yml
subrata71
previously approved these changes
Jun 2, 2026
sha256sum --check matches by filename, so the downloaded tarball must keep its original name to match the checksums.txt entry. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
This PR has been closed because of inactivity. |
The helm-docs release asset is named checksums.txt, not helm-docs_VERSION_checksums.txt. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sebastianiv21
added a commit
that referenced
this pull request
Jun 9, 2026
…ues in sync (#41842) - Adds `README.md.gotmpl` template and generates the chart README via [helm-docs](https://github.com/norwoodj/helm-docs) instead of maintaining it by hand - Backfills `# --` (helm-docs description) and `# @section -- SectionName` annotations on all values in `values.yaml`, including subchart pass-through values - Organizes values into categorized tables: **Appsmith configuration**, **Global parameters**, **Workload configuration**, Networking, Persistence, Service account, External Secrets, MongoDB Community Operator, Redis/MongoDB/PostgreSQL (Bitnami subcharts), Monitoring - Reorders top-level keys so the most commonly edited sections (Appsmith config, global params, workload) appear first - No changes to templates, Chart.yaml, chart logic, or `values.schema.json` Three comment layers now coexist on each value (all are plain YAML comments, no functional impact): | Layer | Purpose | Consumed by | |-------|---------|-------------| | `## @PARAM key.name Description` | Bitnami readme-generator compat | readme-generator-for-helm | | `# -- Description` | helm-docs value description | helm-docs | | `# @section -- SectionName` | helm-docs section grouping | helm-docs | | `# @Schema ...` | JSON schema generation | helm-values-schema-json | ```bash helm-docs --sort-values-order file ``` - [x] `helm-docs --sort-values-order file` produces a clean README with all values in their correct section tables - [x] `helm schema` produces an identical `values.schema.json` (no diff) - [x] `helm template appsmith .` still renders correctly - [x] Existing `helm-unittest` tests pass 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- This is an auto-generated comment: Cypress test results --> > [!WARNING] > Tests have not run on the HEAD dc41fb2 yet > <hr>Tue, 09 Jun 2026 20:26:25 UTC <!-- end of auto-generated comment: Cypress test results --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> * **Documentation** * Major rewrite of the Helm chart README, added a documentation template and a guide on regenerating derived artifacts; expanded and reorganized the Values reference and annotation guidance. * **Chores** * CI workflow renamed and updated to install pinned tooling and enforce that generated Helm schema and README are kept in sync (PRs fail on drift). <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2 tasks
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
3 participants
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
README.md.gotmpltemplate and generates the chart README via helm-docs instead of maintaining it by hand# --(helm-docs description) and# @section -- SectionNameannotations on all values invalues.yaml, including subchart pass-through valuesvalues.schema.jsonAnnotations added
Three comment layers now coexist on each value (all are plain YAML comments, no functional impact):
## @param key.name Description# -- Description# @section -- SectionName# @schema ...Regenerating the README
Test plan
helm-docs --sort-values-order fileproduces a clean README with all values in their correct section tableshelm schemaproduces an identicalvalues.schema.json(no diff)helm template appsmith .still renders correctlyhelm-unittesttests pass🤖 Generated with Claude Code
Warning
Tests have not run on the HEAD dc41fb2 yet
Tue, 09 Jun 2026 20:26:25 UTC
Summary by CodeRabbit
Documentation
Chores