helm-docs

A tool for automatically generating markdown documentation for helm charts.

Installation

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

HelmDocs !

Name	Type	Default Value	Description
version	String	-	Version (image tag) to use from the official image repository as a base container.
image	String	-	Custom image reference in "repository:tag" format to use as a base container.
container	Container	-	Custom container to use as a base container.

Example

dagger -m github.com/sagikazarmark/daggerverse/helm-docs@24c022dde505b24970824dd50f51e719098cfeb3 call \

func (m *MyModule) Example() *dagger.HelmDocs  {
	return dag.
			HelmDocs()
}

@function
def example() -> dagger.HelmDocs:
	return (
		dag.helm_docs()
	)

@func()
example(): HelmDocs {
	return dag
		.helmDocs()
}

Container !

Example

dagger -m github.com/sagikazarmark/daggerverse/helm-docs@24c022dde505b24970824dd50f51e719098cfeb3 call \
 container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			HelmDocs().
			Container()
}

@function
def example() -> dagger.Container:
	return (
		dag.helm_docs()
		.container()
	)

@func()
example(): Container {
	return dag
		.helmDocs()
		.container()
}

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

File !

Name	Type	Default Value	Description
chart	Directory !	-	A directory containing a Helm chart.
templates	[File ! ]	-	A list of Go template files to use for rendering the documentation.
sortValuesOrder	String	-	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 *dagger.Directory) *dagger.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)
}