helm

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78

Entrypoint

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
src	Directory !	-	The helm source
baseHelmContainer	Container	-	base helm container It need contain helm
baseGeneratorContainer	Container	-	Base generator container It need contain readme-generator-for-helm
baseYqContainer	Container	-	Base YQ container It need contain yq

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH

func (m *MyModule) Example(src *dagger.Directory) *dagger.Helm  {
	return dag.
			Helm(src)
}

@function
def example(src: dagger.Directory, ) -> dagger.Helm:
	return (
		dag.helm(src)
	)

@func()
example(src: Directory, ): Helm {
	return dag
		.helm(src)
}

Types

Helm 🔗

helmContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH helm-container

func (m *MyModule) Example(src *dagger.Directory) *dagger.Container  {
	return dag.
			Helm(src).
			Helmcontainer()
}

@function
def example(src: dagger.Directory, ) -> dagger.Container:
	return (
		dag.helm(src)
		.helmcontainer()
	)

@func()
example(src: Directory, ): Container {
	return dag
		.helm(src)
		.helmContainer()
}

generatorContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH generator-container

func (m *MyModule) Example(src *dagger.Directory) *dagger.Container  {
	return dag.
			Helm(src).
			Generatorcontainer()
}

@function
def example(src: dagger.Directory, ) -> dagger.Container:
	return (
		dag.helm(src)
		.generatorcontainer()
	)

@func()
example(src: Directory, ): Container {
	return dag
		.helm(src)
		.generatorContainer()
}

yqContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH yq-container

func (m *MyModule) Example(src *dagger.Directory) *dagger.Container  {
	return dag.
			Helm(src).
			Yqcontainer()
}

@function
def example(src: dagger.Directory, ) -> dagger.Container:
	return (
		dag.helm(src)
		.yqcontainer()
	)

@func()
example(src: Directory, ): Container {
	return dag
		.helm(src)
		.yqContainer()
}

ci() 🔗

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
registry	String	-	The registry You need to provide it if run from CI
repository	String	-	The repository inside the registry You need to provide it if run from CI
helmPaths	[String ! ]	["."]	The helm paths
ci	String	-	If you are on CI, provide the CI type to set the right stuff when commit to ovoid loop for ever
version	String	-	The image version to publish You need to provide it if run from CI
registryUsername	Secret	-	The registry username You need to provide it if run from CI
registryPassword	Secret	-	The registry password You need to provide it if run from CI
gitToken	Secret	-	The git token You need to provide it if run from CI
gitRepoUrl	String	-	The git repo URL You need to provide it when you are on PullRequest
gitBranch	String	-	The git branch where you should to push You need to provide it when you are on PullRequest or on Tag
dryRun	Boolean	-	Dry-run: skip push and git commit/push even when –ci is set.

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH ci

func (m *MyModule) Example(src *dagger.Directory) *dagger.Directory  {
	return dag.
			Helm(src).
			Ci()
}

@function
def example(src: dagger.Directory, ) -> dagger.Directory:
	return (
		dag.helm(src)
		.ci()
	)

@func()
example(src: Directory, ): Directory {
	return dag
		.helm(src)
		.ci()
}

generateCi() 🔗

GenerateCi generates CI pipeline files for the given CI system.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
ci	String !	-	The CI runner: github, jenkins, or gitlab
branches	[String ! ]	["main"]	Branches that trigger the pipeline
helmPaths	[String ! ]	["."]	Helm chart directory paths
daggerVersion	String	-	Dagger CLI version to use in CI (empty = engine default)
registry	String	-	OCI registry URL. Empty = renderer default (ghcr.io on GitHub).
repository	String	-	Repository path inside the registry.
defaultBranch	String	"main"	Branch commits land here when running on a tag.
moduleRef	String	-	Configurable dagger module reference. Defaults to this module’s current version (auto-detected).
registryUsernameKey	String	-	GitHub: secret name for registry username (empty = github.actor).
registryPasswordKey	String	-	GitHub: secret name for registry password (empty = GITHUB_TOKEN).
registryCredential	String	-	Jenkins: credential id for registry username/password.
gitTokenCredential	String	-	Jenkins: credential id for git token.
registryUsernameVar	String	-	GitLab: CI/CD variable name for registry username.
registryPasswordVar	String	-	GitLab: CI/CD variable name for registry password.
gitTokenVar	String	-	GitLab: CI/CD variable name for git token.

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH generate-ci --ci string

func (m *MyModule) Example(src *dagger.Directory, ci string) *dagger.Directory  {
	return dag.
			Helm(src).
			Generateci(ci)
}

@function
def example(src: dagger.Directory, ci: str) -> dagger.Directory:
	return (
		dag.helm(src)
		.generateci(ci)
	)

@func()
example(src: Directory, ci: string): Directory {
	return dag
		.helm(src)
		.generateCi(ci)
}

generateDocumentation() 🔗

GenerateDocumentation permit to generate helm documentation It will return the readme file

Return Type

File !

Arguments

Name	Type	Default Value	Description
targetFile	String	"README.md"	The target file
configFile	String	-	Config file for readme-generator

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH generate-documentation

func (m *MyModule) Example(src *dagger.Directory) *dagger.File  {
	return dag.
			Helm(src).
			Generatedocumentation()
}

@function
def example(src: dagger.Directory, ) -> dagger.File:
	return (
		dag.helm(src)
		.generatedocumentation()
	)

@func()
example(src: Directory, ): File {
	return dag
		.helm(src)
		.generateDocumentation()
}

generateSchema() 🔗

GenerateSchema permit to generate helm schema It will return the values.schema.json file

Return Type

File !

Arguments

Name	Type	Default Value	Description
targetFile	String	"values.schema.json"	The target file
configFile	String	-	Config file for readme-generator

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH generate-schema

func (m *MyModule) Example(src *dagger.Directory) *dagger.File  {
	return dag.
			Helm(src).
			Generateschema()
}

@function
def example(src: dagger.Directory, ) -> dagger.File:
	return (
		dag.helm(src)
		.generateschema()
	)

@func()
example(src: Directory, ): File {
	return dag
		.helm(src)
		.generateSchema()
}

lint() 🔗

Lint permit to lint helm chart

Return Type

String !

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH lint

func (m *MyModule) Example(ctx context.Context, src *dagger.Directory) string  {
	return dag.
			Helm(src).
			Lint(ctx)
}

@function
async def example(src: dagger.Directory, ) -> str:
	return await (
		dag.helm(src)
		.lint()
	)

@func()
async example(src: Directory, ): Promise<string> {
	return dag
		.helm(src)
		.lint()
}

migrateValuesTags() 🔗

MigrateValuesTags permit to migrate values.yaml metadata tags It rewrites old concrete array indices ([0], [1]) in @param / @skip / @extra metadata comment paths to the new generic [] syntax used by the Go readme-generator-for-helm fork. The operation is idempotent and only modifies metadata comment lines; YAML values, modifiers, and descriptions are preserved. It returns the migrated values file.

Return Type

File !

Arguments

Name	Type	Default Value	Description
valuesFile	String	"values.yaml"	The values file to migrate
configFile	String	-	Config file for readme-generator
outputFile	String	-	Output file path. If empty, valuesFile is rewritten in place.

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH migrate-values-tags

func (m *MyModule) Example(src *dagger.Directory) *dagger.File  {
	return dag.
			Helm(src).
			Migratevaluestags()
}

@function
def example(src: dagger.Directory, ) -> dagger.File:
	return (
		dag.helm(src)
		.migratevaluestags()
	)

@func()
example(src: Directory, ): File {
	return dag
		.helm(src)
		.migrateValuesTags()
}

push() 🔗

Push helm chart on registry (OCI format only) It will return the updated Chart.yaml file with the expected version

Return Type

File !

Arguments

Name	Type	Default Value	Description
registryUrl	String !	-	The registry url
repositoryName	String !	-	The repository name
version	String !	-	The version

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH push --registry-url string --repository-name string --version string

func (m *MyModule) Example(src *dagger.Directory, registryUrl string, repositoryName string, version string) *dagger.File  {
	return dag.
			Helm(src).
			Push(registryUrl, repositoryName, version)
}

@function
def example(src: dagger.Directory, registryurl: str, repositoryname: str, version: str) -> dagger.File:
	return (
		dag.helm(src)
		.push(registryurl, repositoryname, version)
	)

@func()
example(src: Directory, registryUrl: string, repositoryName: string, version: string): File {
	return dag
		.helm(src)
		.push(registryUrl, repositoryName, version)
}

updateChart() 🔗

Update Chart.yaml file

Return Type

File !

Arguments

Name	Type	Default Value	Description
key	String !	-	The key to update on yaml file
value	String !	-	The new value to put

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH update-chart --key string --value string

func (m *MyModule) Example(src *dagger.Directory, key string, value string) *dagger.File  {
	return dag.
			Helm(src).
			Updatechart(key, value)
}

@function
def example(src: dagger.Directory, key: str, value: str) -> dagger.File:
	return (
		dag.helm(src)
		.updatechart(key, value)
	)

@func()
example(src: Directory, key: string, value: string): File {
	return dag
		.helm(src)
		.updateChart(key, value)
}

updateValues() 🔗

Update values.yaml file

Return Type

File !

Arguments

Name	Type	Default Value	Description
key	String !	-	The key to update on yaml file
value	String !	-	The new value to put

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH update-values --key string --value string

func (m *MyModule) Example(src *dagger.Directory, key string, value string) *dagger.File  {
	return dag.
			Helm(src).
			Updatevalues(key, value)
}

@function
def example(src: dagger.Directory, key: str, value: str) -> dagger.File:
	return (
		dag.helm(src)
		.updatevalues(key, value)
	)

@func()
example(src: Directory, key: string, value: string): File {
	return dag
		.helm(src)
		.updateValues(key, value)
}

withRepository() 🔗

WithRepository permit to login on private helm repository

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
name	String	-	The repository name You need to set it when is not OCI format
url	String !	-	The repository url
isOci	Boolean	false	Is it an OCI repository
username	Secret !	-	The repository username
password	Secret !	-	The repository password

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH with-repository --url string --username env:MYSECRET --password env:MYSECRET

func (m *MyModule) Example(src *dagger.Directory, url string, username *dagger.Secret, password *dagger.Secret) *dagger.Helm  {
	return dag.
			Helm(src).
			Withrepository(url, username, password)
}

@function
def example(src: dagger.Directory, url: str, username: dagger.Secret, password: dagger.Secret) -> dagger.Helm:
	return (
		dag.helm(src)
		.withrepository(url, username, password)
	)

@func()
example(src: Directory, url: string, username: Secret, password: Secret): Helm {
	return dag
		.helm(src)
		.withRepository(url, username, password)
}

withSource() 🔗

WithSource permit to update the current source

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
src	Directory !	-	The source directory

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH with-source --src DIR_PATH

func (m *MyModule) Example(src *dagger.Directory, src1 *dagger.Directory) *dagger.Helm  {
	return dag.
			Helm(src).
			Withsource(src1)
}

@function
def example(src: dagger.Directory, src1: dagger.Directory) -> dagger.Helm:
	return (
		dag.helm(src)
		.withsource(src1)
	)

@func()
example(src: Directory, src1: Directory): Helm {
	return dag
		.helm(src)
		.withSource(src1)
}

withWorkDir() 🔗

WithWorkDir change the working directory on all containers

Return Type

Helm !

Arguments

Name	Type	Default Value	Description
path	String !	-	The path where to go as working directory

Example

dagger -m github.com/disaster37/dagger-library-go/helm@b753e824a9c4beec16d624fb1b7f59b073934c78 call \
 --src DIR_PATH with-work-dir --path string

func (m *MyModule) Example(src *dagger.Directory, path string) *dagger.Helm  {
	return dag.
			Helm(src).
			Withworkdir(path)
}

@function
def example(src: dagger.Directory, path: str) -> dagger.Helm:
	return (
		dag.helm(src)
		.withworkdir(path)
	)

@func()
example(src: Directory, path: string): Helm {
	return dag
		.helm(src)
		.withWorkDir(path)
}