diff --git a/.flox/env/manifest.lock b/.flox/env/manifest.lock index 693d10423e..3175a8ee8a 100644 --- a/.flox/env/manifest.lock +++ b/.flox/env/manifest.lock @@ -23,11 +23,6 @@ "gum": { "pkg-path": "gum" }, - "helm-docs": { - "pkg-path": "helm-docs", - "pkg-group": "helm-docs", - "version": "1.14.2" - }, "kubeconform": { "pkg-path": "kubeconform", "pkg-group": "kubeconform", @@ -289,93 +284,6 @@ "group": "actionlint", "priority": 5 }, - { - "attr_path": "helm-docs", - "broken": false, - "derivation": "/nix/store/y91aqsk2pipz2vx62rdxbs5zdra3xxry-helm-docs-1.14.2.drv", - "description": "Tool for automatically generating markdown documentation for Helm charts", - "install_id": "helm-docs", - "license": "GPL-3.0-only", - "locked_url": "https://github.com/flox/nixpkgs?rev=f13ff45afd1bb73e640eaa08a7066dbed07e3238", - "name": "helm-docs-1.14.2", - "pname": "helm-docs", - "rev": "f13ff45afd1bb73e640eaa08a7066dbed07e3238", - "rev_count": 1049422, - "rev_date": "2026-08-07T12:45:23Z", - "scrape_date": "2026-08-09T04:55:06.299662Z", - "stabilities": [ - "unstable" - ], - "unfree": false, - "version": "1.14.2", - "outputs_to_install": [ - "out" - ], - "outputs": { - "out": "/nix/store/0i1kal44yygaycd4s287hxsj1prg35a3-helm-docs-1.14.2" - }, - "system": "aarch64-darwin", - "group": "helm-docs", - "priority": 5 - }, - { - "attr_path": "helm-docs", - "broken": false, - "derivation": "/nix/store/bqlkqal7i3n8ysx86a4464qpsjy8wsgw-helm-docs-1.14.2.drv", - "description": "Tool for automatically generating markdown documentation for Helm charts", - "install_id": "helm-docs", - "license": "GPL-3.0-only", - "locked_url": "https://github.com/flox/nixpkgs?rev=f13ff45afd1bb73e640eaa08a7066dbed07e3238", - "name": "helm-docs-1.14.2", - "pname": "helm-docs", - "rev": "f13ff45afd1bb73e640eaa08a7066dbed07e3238", - "rev_count": 1049422, - "rev_date": "2026-08-07T12:45:23Z", - "scrape_date": "2026-08-09T05:24:28.058381Z", - "stabilities": [ - "unstable" - ], - "unfree": false, - "version": "1.14.2", - "outputs_to_install": [ - "out" - ], - "outputs": { - "out": "/nix/store/p2cvfmi5h311fg503nq0fi2dmihsgbcp-helm-docs-1.14.2" - }, - "system": "aarch64-linux", - "group": "helm-docs", - "priority": 5 - }, - { - "attr_path": "helm-docs", - "broken": false, - "derivation": "/nix/store/4mp8lw4dhpk6s09y63w61p122daba7ml-helm-docs-1.14.2.drv", - "description": "Tool for automatically generating markdown documentation for Helm charts", - "install_id": "helm-docs", - "license": "GPL-3.0-only", - "locked_url": "https://github.com/flox/nixpkgs?rev=f13ff45afd1bb73e640eaa08a7066dbed07e3238", - "name": "helm-docs-1.14.2", - "pname": "helm-docs", - "rev": "f13ff45afd1bb73e640eaa08a7066dbed07e3238", - "rev_count": 1049422, - "rev_date": "2026-08-07T12:45:23Z", - "scrape_date": "2026-08-09T05:58:43.732862Z", - "stabilities": [ - "unstable" - ], - "unfree": false, - "version": "1.14.2", - "outputs_to_install": [ - "out" - ], - "outputs": { - "out": "/nix/store/68b6nv2gc1j7g6js3wj2plj2dsvx2vnx-helm-docs-1.14.2" - }, - "system": "x86_64-linux", - "group": "helm-docs", - "priority": 5 - }, { "attr_path": "kubeconform", "broken": false, @@ -1543,11 +1451,6 @@ "manifest": { "schema-version": "1.14.0", "install": { - "helm-docs": { - "pkg-path": "helm-docs", - "pkg-group": "helm-docs", - "version": "1.14.2" - }, "kubeconform": { "pkg-path": "kubeconform", "pkg-group": "kubeconform", diff --git a/.github/workflows/fern-docs-ci.yaml b/.github/workflows/fern-docs-ci.yaml index 592d0f88b6..95306c0594 100644 --- a/.github/workflows/fern-docs-ci.yaml +++ b/.github/workflows/fern-docs-ci.yaml @@ -10,6 +10,7 @@ on: pull_request: paths: - 'docs/**' + - 'k8s/helm/values.yaml' - '.github/workflows/fern-docs-ci.yaml' permissions: diff --git a/.gitignore b/.gitignore index 4d05249d9d..f216dca4e4 100644 --- a/.gitignore +++ b/.gitignore @@ -154,7 +154,7 @@ docs/fern/generated/ docs/fern/versions/[0-9]*.yml docs/fern/versions/v[0-9]*.yml -# Generated from k8s/helm/values.yaml + README.md at docs build time (docs/fern/scripts/sync-helm-docs.mjs) +# Generated from k8s/helm/README.md + k8s/helm/values.yaml at docs build time (docs/fern/scripts/sync-helm-docs.mjs) docs/helm/index.mdx # nektos/act files commonly used diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a16334b40d..8eab50b7bf 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -68,21 +68,6 @@ repos: docs/set-up/config-reference\.mdx )$ - - repo: https://github.com/norwoodj/helm-docs - # The container itself is 'latest' no matter what here - rev: v1.14.2 - hooks: - - id: helm-docs - files: | - (?x)^( - k8s/helm/values\.yaml| - k8s/helm/Chart\.yaml| - k8s/helm/helm-docs-template/nemo-helm-readme\.md\.gotmpl - )$ - args: - - --chart-search-root=k8s/helm/ - - --template-files=k8s/helm/helm-docs-template/nemo-helm-readme.md.gotmpl - - repo: local hooks: - id: uv-lock diff --git a/docs/fern/scripts/sync-helm-docs.mjs b/docs/fern/scripts/sync-helm-docs.mjs index 6e21039c92..0ff2be109b 100644 --- a/docs/fern/scripts/sync-helm-docs.mjs +++ b/docs/fern/scripts/sync-helm-docs.mjs @@ -4,7 +4,7 @@ /** * Generate docs/helm/index.mdx from k8s/helm/README.md and k8s/helm/values.yaml. * - * Intro prose comes from README.md (generated by helm-docs); the Values section + * Intro prose comes from the checked-in Helm chart README; the Values section * embeds the raw values.yaml as a syntax-highlighted code block. * * Runs as part of `npm run prepare` before every Fern build. Do not edit @@ -45,7 +45,9 @@ function stripLeadingSpdxComments(markdown) { while ( lines.length && - (lines[0].startsWith("