Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
OpenDAS
dynamo
Commits
fd839b8d
Unverified
Commit
fd839b8d
authored
Feb 20, 2026
by
Julien Mancuso
Committed by
GitHub
Feb 20, 2026
Browse files
fix: reintroduce helm docs autogeneration (#6459)
Signed-off-by:
Julien Mancuso
<
jmancuso@nvidia.com
>
parent
a798e08c
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
66 additions
and
1 deletion
+66
-1
deploy/helm/charts/platform/.helmignore
deploy/helm/charts/platform/.helmignore
+2
-0
deploy/helm/charts/platform/Makefile
deploy/helm/charts/platform/Makefile
+57
-0
deploy/operator/Makefile
deploy/operator/Makefile
+7
-1
No files found.
deploy/helm/charts/platform/.helmignore
View file @
fd839b8d
...
@@ -26,3 +26,5 @@ test-values.yaml
...
@@ -26,3 +26,5 @@ test-values.yaml
minikube-demo-values.yaml
minikube-demo-values.yaml
# subchart sources
# subchart sources
components/
components/
bin/
Makefile
deploy/helm/charts/platform/Makefile
0 → 100644
View file @
fd839b8d
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
LOCALBIN
?=
$(
shell
pwd
)
/bin
$(LOCALBIN)
:
mkdir
-p
$(LOCALBIN)
HELM_DOCS_VERSION
?=
1.14.2
HELM_DOCS
?=
$(LOCALBIN)
/helm-docs-
$(HELM_DOCS_VERSION)
##@ General
.PHONY
:
help
help
:
##
Display this help
@
awk
'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) }'
$(MAKEFILE_LIST)
##@ Helm Documentation
.PHONY
:
helm-docs-install
helm-docs-install
:
$(HELM_DOCS)
##
Download helm-docs locally if necessary
$(HELM_DOCS)
:
$(LOCALBIN)
@
echo
"Downloading helm-docs
$(HELM_DOCS_VERSION)
..."
@
ARCH
=
$$
(
uname
-m
)
;
\
case
$$
ARCH
in
aarch64
)
ARCH
=
arm64
;;
esac
;
\
OS
=
$$
(
uname
-s
)
;
\
curl
-fsSL
"https://github.com/norwoodj/helm-docs/releases/download/v
$(HELM_DOCS_VERSION)
/helm-docs_
$(HELM_DOCS_VERSION)
_
$
${OS}
_
$
${ARCH}
.tar.gz"
|
\
tar
xz
-C
$(LOCALBIN)
helm-docs
&&
\
mv
$(LOCALBIN)
/helm-docs
$(HELM_DOCS)
.PHONY
:
generate-helm-docs
generate-helm-docs
:
helm-docs-install
##
Generate README.md from values.yaml and README.md.gotmpl
@
echo
"Generating Helm chart documentation..."
@
$(HELM_DOCS)
\
--template-files
=
README.md.gotmpl
\
--output-file
=
README.md
\
--sort-values-order
=
file
\
--chart-to-generate
=
.
\
--ignore-non-descriptions
@
rm
-rf
$(LOCALBIN)
@
echo
"Generated README.md"
.PHONY
:
helm-docs-clean
helm-docs-clean
:
##
Remove generated helm documentation
@
rm
-f
README.md
@
echo
"Cleaned generated README.md"
\ No newline at end of file
deploy/operator/Makefile
View file @
fd839b8d
...
@@ -45,7 +45,7 @@ help: ## Display this help.
...
@@ -45,7 +45,7 @@ help: ## Display this help.
##@ Development
##@ Development
.PHONY
:
check
.PHONY
:
check
check
:
generate manifests generate-api-docs
check
:
generate manifests generate-api-docs
generate-helm-docs
@
echo
"> Checking for uncommitted changes"
@
echo
"> Checking for uncommitted changes"
@
if
[
-n
"
$$
(git status --porcelain)"
]
;
then
\
@
if
[
-n
"
$$
(git status --porcelain)"
]
;
then
\
echo
"ERROR: Git tree is dirty after running validation steps."
;
\
echo
"ERROR: Git tree is dirty after running validation steps."
;
\
...
@@ -342,6 +342,12 @@ generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRD
...
@@ -342,6 +342,12 @@ generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRD
# across API versions; prepend "v1beta1 " to affected v1beta1 headings and links.
# across API versions; prepend "v1beta1 " to affected v1beta1 headings and links.
python3 docs/fix-api-anchors.py ../../docs/pages/kubernetes/api-reference.md
python3 docs/fix-api-anchors.py ../../docs/pages/kubernetes/api-reference.md
HELM_CHART_DIR
:=
../helm/charts/platform
.PHONY
:
generate-helm-docs
generate-helm-docs
:
##
Generate Helm chart README from values.yaml and template
@
$(MAKE)
-C
$(HELM_CHART_DIR)
generate-helm-docs
.PHONY
:
coverage
.PHONY
:
coverage
coverage
:
test
coverage
:
test
go tool cover
-func
=
cover.out
go tool cover
-func
=
cover.out
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment