golang
A utility module for building, testing, and linting Go projectsInstallation
dagger install github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021
Entrypoint
Return Type
Golang !
Arguments
Name | Type | Description |
---|---|---|
ctr | Container | No description provided |
proj | Directory | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
func (m *myModule) example() *Golang {
return dag.
Golang()
}
@function
def example() -> dag.Golang:
return (
dag.golang()
)
@func()
example(): Golang {
return dag
.golang()
}
Types
Golang 🔗
build() 🔗
Build the Go project
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | The Go source code to build |
args | [String ! ] ! | - | Arguments to `go build` |
arch | String | - | The architecture for GOARCH |
os | String | - | The operating system for GOOS |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
build --args string1 --args string2
func (m *myModule) example(args []string) *Directory {
return dag.
Golang().
Build(args)
}
@function
def example(args: List[str]) -> dagger.Directory:
return (
dag.golang()
.build(args)
)
@func()
example(args: string[]): Directory {
return dag
.golang()
.build(args)
}
buildContainer() 🔗
Build a Go project returning a Container containing the build
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | The Go source code to build |
args | [String ! ] | - | Arguments to `go build` |
arch | String | - | The architecture for GOARCH |
os | String | - | The operating system for GOOS |
base | Container | - | Base container in which to copy the build |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
build-container
func (m *myModule) example() *Container {
return dag.
Golang().
BuildContainer()
}
@function
def example() -> dagger.Container:
return (
dag.golang()
.build_container()
)
@func()
example(): Container {
return dag
.golang()
.buildContainer()
}
test() 🔗
Test the Go project
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | The Go source code to test |
component | String | - | Arguments to `go test` +default "./..." |
coverageLocation | String | - | Generate a coverprofile or not at a location +default ./ |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
test
func (m *myModule) example(ctx context.Context) string {
return dag.
Golang().
Test(ctx)
}
@function
async def example() -> str:
return await (
dag.golang()
.test()
)
@func()
async example(): Promise<string> {
return dag
.golang()
.test()
}
attach() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
container | Container ! | - | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
attach --container IMAGE:TAG
func (m *myModule) example(container *Container) *Container {
return dag.
Golang().
Attach(container)
}
@function
def example(container: dagger.Container) -> dagger.Container:
return (
dag.golang()
.attach(container)
)
@func()
example(container: Container): Container {
return dag
.golang()
.attach(container)
}
service() 🔗
Get a Service container running dockerd
Return Type
Service !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
dockerVersion | String | "24.0" | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
service
func (m *myModule) example() *Service {
return dag.
Golang().
Service()
}
@function
def example() -> dagger.Service:
return (
dag.golang()
.service()
)
@func()
example(): Service {
return dag
.golang()
.service()
}
vulncheck() 🔗
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | The Go source code to lint |
component | String | - | Workdir to run golangci-lint +default "./..." |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
vulncheck
func (m *myModule) example(ctx context.Context) string {
return dag.
Golang().
Vulncheck(ctx)
}
@function
async def example() -> str:
return await (
dag.golang()
.vulncheck()
)
@func()
async example(): Promise<string> {
return dag
.golang()
.vulncheck()
}
golangciLint() 🔗
Lint the Go project
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | The Go source code to lint |
component | String | - | Workdir to run golangci-lint +default "./..." |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
golangci-lint
func (m *myModule) example(ctx context.Context) string {
return dag.
Golang().
GolangciLint(ctx)
}
@function
async def example() -> str:
return await (
dag.golang()
.golangci_lint()
)
@func()
async example(): Promise<string> {
return dag
.golang()
.golangciLint()
}
base() 🔗
Sets up the Container with a golang image and cache volumes
Return Type
Golang !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
version | String ! | - | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
base --version string
func (m *myModule) example(version string) *Golang {
return dag.
Golang().
Base(version)
}
@function
def example(version: str) -> dag.Golang:
return (
dag.golang()
.base(version)
)
@func()
example(version: string): Golang {
return dag
.golang()
.base(version)
}
container() 🔗
The go build container
Return Type
Container !
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
container
func (m *myModule) example() *Container {
return dag.
Golang().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.golang()
.container()
)
@func()
example(): Container {
return dag
.golang()
.container()
}
project() 🔗
The go project directory
Return Type
Directory !
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
project
func (m *myModule) example() *Directory {
return dag.
Golang().
Project()
}
@function
def example() -> dagger.Directory:
return (
dag.golang()
.project()
)
@func()
example(): Directory {
return dag
.golang()
.project()
}
withProject() 🔗
Specify the Project to use in the module
Return Type
Golang !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
dir | Directory ! | - | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
with-project --dir DIR_PATH
func (m *myModule) example(dir *Directory) *Golang {
return dag.
Golang().
WithProject(dir)
}
@function
def example(dir: dagger.Directory) -> dag.Golang:
return (
dag.golang()
.with_project(dir)
)
@func()
example(dir: Directory): Golang {
return dag
.golang()
.withProject(dir)
}
withContainer() 🔗
Bring your own container
Return Type
Golang !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
ctr | Container ! | - | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
with-container --ctr IMAGE:TAG
func (m *myModule) example(ctr *Container) *Golang {
return dag.
Golang().
WithContainer(ctr)
}
@function
def example(ctr: dagger.Container) -> dag.Golang:
return (
dag.golang()
.with_container(ctr)
)
@func()
example(ctr: Container): Golang {
return dag
.golang()
.withContainer(ctr)
}
buildRemote() 🔗
Build a remote git repo
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
remote | String ! | - | No description provided |
ref | String ! | - | No description provided |
module | String ! | - | No description provided |
arch | String | - | No description provided |
platform | String | - | No description provided |
Example
dagger -m github.com/dannyhorvath0/dagger-modules/golang@6deb553db667310ddb9ff71c94727c19f9473021 call \
build-remote --remote string --ref string --module string
func (m *myModule) example(remote string, ref string, module string) *Directory {
return dag.
Golang().
BuildRemote(remote, ref, module)
}
@function
def example(remote: str, ref: str, module: str) -> dagger.Directory:
return (
dag.golang()
.build_remote(remote, ref, module)
)
@func()
example(remote: string, ref: string, module: string): Directory {
return dag
.golang()
.buildRemote(remote, ref, module)
}