Dagger
Search

go-orb

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/go-orb/plugins@923546e98d22e4e3978984bd84795b1eef9c25d0

Entrypoint

Return Type
GoOrb
Example
func (m *myModule) example() *GoOrb  {
	return dag.
			GoOrb()
}

Types

GoOrb 🔗

modules() 🔗

Returns all modules in root

Return Type
[String ! ] !
Arguments
NameTypeDefault ValueDescription
rootDirectory !-No description provided
Example
func (m *myModule) example(ctx context.Context, root *Directory) []string  {
	return dag.
			GoOrb().
			Modules(ctx, root)
}

lint() 🔗

Lints all modules starting from root with golangci-lint

Return Type
GoOrbAllResult !
Arguments
NameTypeDefault ValueDescription
rootDirectory !-No description provided
golangciConfigFile -No description provided
Example
func (m *myModule) example(root *Directory) *GoOrbAllResult  {
	return dag.
			GoOrb().
			Lint(root)
}

test() 🔗

Tests all modules starting from root with go test ./... -v -race -cover

Return Type
GoOrbAllResult !
Arguments
NameTypeDefault ValueDescription
rootDirectory !-No description provided
Example
func (m *myModule) example(root *Directory) *GoOrbAllResult  {
	return dag.
			GoOrb().
			Test(root)
}

tidy() 🔗

Runs go mod tidy -go=1.23.6 in all modules starting with root

Return Type
GoOrbAllResult !
Arguments
NameTypeDefault ValueDescription
rootDirectory !-No description provided
Example
func (m *myModule) example(root *Directory) *GoOrbAllResult  {
	return dag.
			GoOrb().
			Tidy(root)
}

update() 🔗

Runs go get -u -t ./... in all modules starting with root

Return Type
GoOrbAllResult !
Arguments
NameTypeDefault ValueDescription
rootDirectory !-No description provided
Example
func (m *myModule) example(root *Directory) *GoOrbAllResult  {
	return dag.
			GoOrb().
			Update(root)
}

GoOrbAllResult 🔗

logs() 🔗

Return Type
[String ! ] !
Example
func (m *myModule) example(ctx context.Context, root *Directory) []string  {
	return dag.
			GoOrb().
			Update(root).
			Logs(ctx)
}

source() 🔗

Return Type
Directory !
Example
func (m *myModule) example(root *Directory) *Directory  {
	return dag.
			GoOrb().
			Update(root).
			Source()
}