docs: add Helm to CONTRIBUTING prerequisites for chart tests - #571
Conversation
cevheri
left a comment
There was a problem hiding this comment.
Thanks, this matches what was measured on a fresh checkout: the twelve files, the 166 errors, the two commands and the 401 trap are all right. Two small changes before merge, both attached as suggestions you can apply with one click.
- The
bun run testline in the scripts block is one long comment and carries two phrases that will not age well: the single-process failures are deterministic rather than a flake, and nothing tracks them yet. How thetestscript itself gets fixed is a maintainer decision and will be written down where it lands, so keep this line to the Helm fact and let thetest:ciline say what it is. - The file count in Prerequisites reads as thirteen (the glob plus two names); ten of the eleven
helm-chart-*files spawn helm, so name the ten.
|
Your checks are green, but they last ran on 2026-09-05, a day before that tag, so they describe a main that no longer exists. Please take current main before the next round. From a fork: Why now rather than at merge time: the chart version sync guard is the first step of |
|
any update |
|
Updated this branch myself rather than leaving it to you: it was 85 commits behind and the review had been open two days. Your commit is untouched. Both script-block suggestions went in verbatim. The Prerequisites line I wrote from the review body, not from my own suggestion text, because the two disagreed and the suggestion was wrong. Measured with
All eight local gates clean. Merging once checks are green. |
|
@SatvikMishra08 Worth saying: your 166 and your 401 trap both held up under measurement, and that is the hard part of a docs fix. Keep contributing, it sharpens exactly this. |
Summary
CONTRIBUTING.md listed Bun/Node and Git, then told contributors to run
bun run test. Chart unit tests need Helm 4.1.3 (CI pin) andhelm dependency buildfor the gitignored PostgreSQL subchart. Without them, a fresh clone gets ~166helmPATH failures (see #569).Docs-only:
helm repo add/helm dependency build … --skip-refreshunder Prerequisitesbun run test, and preferbun run test:cifor a CI-matching checkdocker login→ 401 trapCloses #570
Test plan
bun run testnote does not duplicate the Helm Chart Changes sectionDocs-only change; local
bun run test:cinot run (full suite is heavy for a CONTRIBUTING.md edit).