Dagger
Search

yamllint

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/softwaredevelop/daggerverse/yamllint@53839e7afff3f86fc016726ef680e4af762336f1

Entrypoint

Return Type 
Yamllint !
Arguments
NameTypeDefault ValueDescription
imageString -Custom image reference in "repository:tag" format to use as a base container.
Example
dagger -m github.com/softwaredevelop/daggerverse/yamllint@53839e7afff3f86fc016726ef680e4af762336f1 call \

func (m *myModule) example() *Yamllint  {
	return dag.
			Yamllint()
}
@function
def example() -> dag.Yamllint:
	return (
		dag.yamllint()
	)
@func()
example(): Yamllint {
	return dag
		.yamllint()
}

Types

Yamllint 🔗

Yamllint is a module for checking YAML files.

image() 🔗

Return Type 
String !
Example
dagger -m github.com/softwaredevelop/daggerverse/yamllint@53839e7afff3f86fc016726ef680e4af762336f1 call \
 image
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Yamllint().
			Image(ctx)
}
@function
async def example() -> str:
	return await (
		dag.yamllint()
		.image()
	)
@func()
async example(): Promise<string> {
	return dag
		.yamllint()
		.image()
}

ctr() 🔗

Return Type 
Container !
Example
dagger -m github.com/softwaredevelop/daggerverse/yamllint@53839e7afff3f86fc016726ef680e4af762336f1 call \
 ctr
func (m *myModule) example() *Container  {
	return dag.
			Yamllint().
			Ctr()
}
@function
def example() -> dagger.Container:
	return (
		dag.yamllint()
		.ctr()
	)
@func()
example(): Container {
	return dag
		.yamllint()
		.ctr()
}

container() 🔗

Container returns the underlying Dagger container

Return Type 
Container !
Example
dagger -m github.com/softwaredevelop/daggerverse/yamllint@53839e7afff3f86fc016726ef680e4af762336f1 call \
 container
func (m *myModule) example() *Container  {
	return dag.
			Yamllint().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.yamllint()
		.container()
	)
@func()
example(): Container {
	return dag
		.yamllint()
		.container()
}

check() 🔗

Check runs yamllint on the provided source directory.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-source is an optional argument that specifies a directory.
Example
dagger -m github.com/softwaredevelop/daggerverse/yamllint@53839e7afff3f86fc016726ef680e4af762336f1 call \
 check --source DIR_PATH
func (m *myModule) example(source *Directory) *Container  {
	return dag.
			Yamllint().
			Check(source)
}
@function
def example(source: dagger.Directory) -> dagger.Container:
	return (
		dag.yamllint()
		.check(source)
	)
@func()
example(source: Directory): Container {
	return dag
		.yamllint()
		.check(source)
}