Dagger
Search

buf

No long description provided.

Installation

dagger install github.com/fluent-ci-templates/buf-pipeline@52f73c13b30d01b7c0ca571fe5b1e989e25354af

Entrypoint

Return Type 
Buf
Example
func (m *myModule) example() *Buf  {
	return dag.
			Buf()
}
@function
def example() -> dag.Buf:
	return (
		dag.buf()
	)
@func()
example(): Buf {
	return dag
		.buf()
}

Types

Buf

push()

Push your Protobuf files to the Buf Registry

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
tokenSecret !-No description provided
Example
dagger -m github.com/fluent-ci-templates/buf-pipeline@52f73c13b30d01b7c0ca571fe5b1e989e25354af call \
 push --src DIR_PATH --token env:MYSECRET
func (m *myModule) example(ctx context.Context, src *Directory, token *Secret) string  {
	return dag.
			Buf().
			Push(ctx, src, token)
}
@function
async def example(src: dagger.Directory, token: dagger.Secret) -> str:
	return await (
		dag.buf()
		.push(src, token)
	)
@func()
async example(src: Directory, token: Secret): Promise<string> {
	return dag
		.buf()
		.push(src, token)
}

format()

Format your Protobuf files

Return Type 
Directory !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
Example
dagger -m github.com/fluent-ci-templates/buf-pipeline@52f73c13b30d01b7c0ca571fe5b1e989e25354af call \
 format --src DIR_PATH
func (m *myModule) example(src *Directory) *Directory  {
	return dag.
			Buf().
			Format(src)
}
@function
def example(src: dagger.Directory) -> dagger.Directory:
	return (
		dag.buf()
		.format(src)
	)
@func()
example(src: Directory): Directory {
	return dag
		.buf()
		.format(src)
}

lint()

Lint your Protobuf files

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
Example
dagger -m github.com/fluent-ci-templates/buf-pipeline@52f73c13b30d01b7c0ca571fe5b1e989e25354af call \
 lint --src DIR_PATH
func (m *myModule) example(ctx context.Context, src *Directory) string  {
	return dag.
			Buf().
			Lint(ctx, src)
}
@function
async def example(src: dagger.Directory) -> str:
	return await (
		dag.buf()
		.lint(src)
	)
@func()
async example(src: Directory): Promise<string> {
	return dag
		.buf()
		.lint(src)
}