Dagger
Search

helm-docs

A tool for automatically generating markdown documentation for helm charts.

Installation

dagger install github.com/sagikazarmark/daggerverse/helm-docs@v0.1.0

Entrypoint

Return Type
HelmDocs !
Arguments
NameTypeDescription
versionString Version (image tag) to use from the official image repository as a base container.
imageString Custom image reference in "repository:tag" format to use as a base container.
containerContainer Custom container to use as a base container.
Example
func (m *myModule) example() *HelmDocs  {
	return dag.
			HelmDocs()
}
@function
def example() -> dag.HelmDocs:
	return (
		dag.helm_docs()
	)
@func()
example(): HelmDocs {
	return dag
		.helmDocs()
}

Types

HelmDocs 🔗

container() 🔗

Return Type
Container !
Example
dagger -m github.com/sagikazarmark/daggerverse/helm-docs@24c022dde505b24970824dd50f51e719098cfeb3 call \
 container
func (m *myModule) example() *Container  {
	return dag.
			HelmDocs().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.helm_docs()
		.container()
	)
@func()
example(): Container {
	return dag
		.helmDocs()
		.container()
}

generate() 🔗

Generate markdown documentation for Helm charts from requirements and values files.

Return Type
File !
Arguments
NameTypeDefault ValueDescription
chartDirectory !-A directory containing a Helm chart.
templates[File ! ] -A list of Go template files to use for rendering the documentation.
sortValuesOrderString -Order in which to sort the values table ("alphanum" or "file"). (default "alphanum")
Example
dagger -m github.com/sagikazarmark/daggerverse/helm-docs@24c022dde505b24970824dd50f51e719098cfeb3 call \
 generate --chart DIR_PATH
func (m *myModule) example(chart *Directory) *File  {
	return dag.
			HelmDocs().
			Generate(chart)
}
@function
def example(chart: dagger.Directory) -> dagger.File:
	return (
		dag.helm_docs()
		.generate(chart)
	)
@func()
example(chart: Directory): File {
	return dag
		.helmDocs()
		.generate(chart)
}