diff options
| author | Hywel Andrews <owlandrews@protonmail.com> | 2026-08-18 23:04:36 +0000 |
|---|---|---|
| committer | Kenneth Raplee <kenrap@FreeBSD.org> | 2026-08-19 08:33:45 +0000 |
| commit | 488a8eff7a21b34c0ce0cdc9288e4c2905b3b574 (patch) | |
| tree | fe8f4797c5b93c5a5130c6aedc6db7731178a348 | |
| parent | b444185fa9e38c46782a69c5f23ea688529cbf0f (diff) | |
sysutils/helm-docs: New port
A tool that auto-generates documentation from helm charts into markdown
files. The resulting files contain metadata about their respective chart
and a table with each of the chart's values, their defaults, and an
optional description parsed from comments.
PR: 297599
Approved by: arrowd (co-mentor)
(cherry picked from commit 691c574c56c433a75ef54e2e0b39aa72b61e732f)
| -rw-r--r-- | sysutils/Makefile | 1 | ||||
| -rw-r--r-- | sysutils/helm-docs/Makefile | 30 | ||||
| -rw-r--r-- | sysutils/helm-docs/distinfo | 5 | ||||
| -rw-r--r-- | sysutils/helm-docs/pkg-descr | 10 |
4 files changed, 46 insertions, 0 deletions
diff --git a/sysutils/Makefile b/sysutils/Makefile index 2c884b65c6f6..f3a884c40def 100644 --- a/sysutils/Makefile +++ b/sysutils/Makefile @@ -510,6 +510,7 @@ SUBDIR += healthd SUBDIR += heirloom SUBDIR += helm + SUBDIR += helm-docs SUBDIR += helmfile SUBDIR += herbe SUBDIR += hexpeek diff --git a/sysutils/helm-docs/Makefile b/sysutils/helm-docs/Makefile new file mode 100644 index 000000000000..0362c76e0b66 --- /dev/null +++ b/sysutils/helm-docs/Makefile @@ -0,0 +1,30 @@ +PORTNAME= helm-docs +DISTVERSIONPREFIX= v +DISTVERSION= 1.14.2 +CATEGORIES= sysutils + +MAINTAINER= owlandrews@protonmail.com +COMMENT= Automatically generate markdown documentation from helm charts +WWW= https://github.com/norwoodj/helm-docs + +LICENSE= GPLv3 + +USES= go:modules + +USE_GITHUB= yes +GH_ACCOUNT= norwoodj + +GO_MOD_DIST= github +GO_MODULE= github.com/norwoodj/helm-docs +GO_TARGET= ./cmd/${PORTNAME} + +PLIST_FILES= bin/${PORTNAME} +PORTDOCS= README.md + +OPTIONS_DEFINE= DOCS + +do-install-DOCS-on: + ${MKDIR} ${STAGEDIR}${DOCSDIR} + ${INSTALL_DATA} ${WRKSRC}/${PORTDOCS} ${STAGEDIR}${DOCSDIR}/ + +.include <bsd.port.mk> diff --git a/sysutils/helm-docs/distinfo b/sysutils/helm-docs/distinfo new file mode 100644 index 000000000000..c4dbf6c2a090 --- /dev/null +++ b/sysutils/helm-docs/distinfo @@ -0,0 +1,5 @@ +TIMESTAMP = 1787073088 +SHA256 (go/sysutils_helm-docs/norwoodj-helm-docs-v1.14.2_GH0/go.mod) = dcd4c3ab4b81c124a47bd941580492cd2ecd34808b3e8b727be095ad5fec3089 +SIZE (go/sysutils_helm-docs/norwoodj-helm-docs-v1.14.2_GH0/go.mod) = 1581 +SHA256 (go/sysutils_helm-docs/norwoodj-helm-docs-v1.14.2_GH0/norwoodj-helm-docs-v1.14.2_GH0.tar.gz) = 88d1b3401220b2032cd27974264d2dc0da8f9e7b67a8a929a0848505c4e4a0ae +SIZE (go/sysutils_helm-docs/norwoodj-helm-docs-v1.14.2_GH0/norwoodj-helm-docs-v1.14.2_GH0.tar.gz) = 109180 diff --git a/sysutils/helm-docs/pkg-descr b/sysutils/helm-docs/pkg-descr new file mode 100644 index 000000000000..f84b545514d1 --- /dev/null +++ b/sysutils/helm-docs/pkg-descr @@ -0,0 +1,10 @@ +The helm-docs tool auto-generates documentation from helm charts into markdown +files. The resulting files contain metadata about their respective chart and a +table with each of the chart's values, their defaults, and an optional +description parsed from comments. + +The markdown generation is entirely gotemplate driven. The tool parses metadata +from charts and generates a number of sub-templates that can be referenced in a +template file (by default README.md.gotmpl). If no template file is provided, +the tool has a default internal template that will generate a reasonably +formatted README. |