helm-docs
No long description provided.
Installation
dagger install github.com/sagikazarmark/daggerverse/helm-docs@9a3074edb9cb21746ea2f9dcdd018d520b47f2e6
Entrypoint
Return Type
HelmDocs !
Arguments
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@9a3074edb9cb21746ea2f9dcdd018d520b47f2e6 call \
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@9a3074edb9cb21746ea2f9dcdd018d520b47f2e6 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
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@9a3074edb9cb21746ea2f9dcdd018d520b47f2e6 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)
}