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@6aec8fbf6bb7221b0f9d161e07d730c7d5b3a773

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@6aec8fbf6bb7221b0f9d161e07d730c7d5b3a773 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.

container() 🔗

Container returns the underlying Dagger container

Return Type 
Container !
Example
dagger -m github.com/softwaredevelop/daggerverse/yamllint@6aec8fbf6bb7221b0f9d161e07d730c7d5b3a773 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@6aec8fbf6bb7221b0f9d161e07d730c7d5b3a773 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)
}