Dagger
Search

helm-docs

A tool for automatically generating markdown documentation for helm charts.

Installation

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

Entrypoint

Return Type
HelmDocs !
Arguments
NameTypeDescription
versionString Version (image tag) to use from the official image repository 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 🔗

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
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)
}