docs: add Helm to CONTRIBUTING prerequisites for chart tests - #571
Open
SatvikMishra08 wants to merge 1 commit into
Open
docs: add Helm to CONTRIBUTING prerequisites for chart tests#571SatvikMishra08 wants to merge 1 commit into
SatvikMishra08 wants to merge 1 commit into
Conversation
cevheri
requested changes
Sep 5, 2026
cevheri
left a comment
Member
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.
|
|
||
| - [Bun](https://bun.sh/) (recommended) or Node.js 24+ | ||
| - Git | ||
| - [Helm](https://helm.sh/) 4.1.3 (the version CI runs). Twelve unit files under `tests/unit/` (`helm-chart-*.test.ts`, `distribution-check.test.ts`, `generate-channel-showcase.test.ts`) spawn the `helm` binary. Without it on `PATH`, `bun run test` fails with many `error: Executable not found in $PATH: "helm"` errors. The PostgreSQL subchart tarball is gitignored (`*.tgz`), so a fresh clone also needs: |
Member
There was a problem hiding this comment.
Count and exact number:
Suggested change
| - [Helm](https://helm.sh/) 4.1.3 (the version CI runs). Twelve unit files under `tests/unit/` (`helm-chart-*.test.ts`, `distribution-check.test.ts`, `generate-channel-showcase.test.ts`) spawn the `helm` binary. Without it on `PATH`, `bun run test` fails with many `error: Executable not found in $PATH: "helm"` errors. The PostgreSQL subchart tarball is gitignored (`*.tgz`), so a fresh clone also needs: | |
| - [Helm](https://helm.sh/) 4.1.3 (the version CI runs). Twelve unit files under `tests/unit/` (ten `helm-chart-*.test.ts` files, `distribution-check.test.ts` and `generate-channel-showcase.test.ts`) spawn the `helm` binary. Without it on `PATH`, `bun run test` fails with 166 `error: Executable not found in $PATH: "helm"` errors. The PostgreSQL subchart tarball is gitignored (`*.tgz`), so a fresh clone also needs: |
| bun run typecheck # TypeScript strict | ||
| bun run knip # unused files, exports and dependencies | ||
| bun run test # every test layer; never bare `bun test` | ||
| bun run test # every test layer; never bare `bun test`. Chart tests need Helm + the built subchart (see Prerequisites); without Helm you get ~166 `Executable not found in $PATH: "helm"` failures. Prefer `bun run test:ci` for a CI-matching green run (the interactive `test` script still has a separate single-process flake tracked outside this docs fix). |
Member
There was a problem hiding this comment.
Suggested change
| bun run test # every test layer; never bare `bun test`. Chart tests need Helm + the built subchart (see Prerequisites); without Helm you get ~166 `Executable not found in $PATH: "helm"` failures. Prefer `bun run test:ci` for a CI-matching green run (the interactive `test` script still has a separate single-process flake tracked outside this docs fix). | |
| bun run test # every test layer; never bare `bun test`. Needs Helm and the built subchart, see Prerequisites |
| bun run knip # unused files, exports and dependencies | ||
| bun run test # every test layer; never bare `bun test` | ||
| bun run test # every test layer; never bare `bun test`. Chart tests need Helm + the built subchart (see Prerequisites); without Helm you get ~166 `Executable not found in $PATH: "helm"` failures. Prefer `bun run test:ci` for a CI-matching green run (the interactive `test` script still has a separate single-process flake tracked outside this docs fix). | ||
| bun run test:ci # CI unit/integration lane (green when Prerequisites are met) |
Member
There was a problem hiding this comment.
Suggested change
| bun run test:ci # CI unit/integration lane (green when Prerequisites are met) | |
| bun run test:ci # the same layers with one process per file, which is what CI runs; use it to verify |
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
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
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).