helm-docs

A tool for automatically generating markdown documentation for helm charts.

Installation

dagger install github.com/sagikazarmark/daggerverse/helm-docs@833905febeb1c77937712dd9f69a2c85898c74d9

HelmDocs !

Name	Type	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

func (m *myModule) example() *HelmDocs  {
	return dag.
			HelmDocs()
}

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

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

Container !

Example

dagger -m github.com/sagikazarmark/daggerverse/helm-docs@833905febeb1c77937712dd9f69a2c85898c74d9 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 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@833905febeb1c77937712dd9f69a2c85898c74d9 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)
}