Dagger
Search

go

Copyright © 2024 Patrick Hermann patrick.hermann@sva.de

Installation

dagger install github.com/stuttgart-things/dagger/go@v0.5.0

Entrypoint

Return Type
Go !
Arguments
NameTypeDefault ValueDescription
goLangContainerContainer -golang container It need contain golang
koContainerContainer -No description provided
goLangVersionString "1.23.6"No description provided
srcDirectory -No description provided
Example
func (m *myModule) example() *Go  {
	return dag.
			Go()
}

Types

Go 🔗

src() 🔗

Return Type
Directory !
Example
func (m *myModule) example() *Directory  {
	return dag.
			Go().
			Src()
}

goLangContainer() 🔗

Return Type
Container !
Example
func (m *myModule) example() *Container  {
	return dag.
			Go().
			GoLangContainer()
}

koContainer() 🔗

Return Type
Container !
Example
func (m *myModule) example() *Container  {
	return dag.
			Go().
			KoContainer()
}

getGoLangContainer() 🔗

GetGoLangContainer returns the default image for golang

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
goVersionString !-No description provided
Example
func (m *myModule) example(goVersion string) *Container  {
	return dag.
			Go().
			GetGoLangContainer(goVersion)
}

getKoContainer() 🔗

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
koVersionString "v0.17.1"No description provided
Example
func (m *myModule) example() *Container  {
	return dag.
			Go().
			GetKoContainer()
}

runWorkflowEntryStage() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
lintTimeoutString "500s"No description provided
goVersionString "1.23.6"No description provided
osString "linux"No description provided
archString "amd64"No description provided
goMainFileString "main.go"No description provided
binNameString "main"No description provided
ldflagsString -No description provided
secureGoVersionString "2.22.1"No description provided
lintCanFailBoolean "false"If true, linting can fail without stopping the workflow
testArgString "./..."Arguments for `go test`
securityScanCanFailBoolean "false"If true, security scan can fail without stopping the workflow
trivyScanCanFailBoolean "false"If true, Trivy scan can fail without stopping the workflow
trivySeverityString "HIGH,CRITICAL"Severity levels to include (e.g., "HIGH,CRITICAL")
trivyVersionString "0.59.1"No description provided
Example
func (m *myModule) example(src *Directory) *File  {
	return dag.
			Go().
			RunWorkflowEntryStage(src)
}

lint() 🔗

Lint runs the linter on the provided source code

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
timeoutString "500s"No description provided
Example
func (m *myModule) example(src *Directory) *Container  {
	return dag.
			Go().
			Lint(src)
}

scanTarBallImage() 🔗

Lint runs the linter on the provided source code

Return Type
File !
Arguments
NameTypeDefault ValueDescription
fileFile !-No description provided
Example
func (m *myModule) example(file *File) *File  {
	return dag.
			Go().
			ScanTarBallImage(file)
}

koBuildAndScan() 🔗

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
tokenNameString "GITHUB_TOKEN"No description provided
tokenSecret !-No description provided
repoString "ko.local"No description provided
buildArgString "."No description provided
koVersionString "v0.17.1"No description provided
pushString "true"No description provided
severityFilterString "HIGH,CRITICAL"Comma-separated list of severities to filter (e.g., "HIGH,CRITICAL")
Example
func (m *myModule) example(ctx context.Context, src *Directory, token *Secret) string  {
	return dag.
			Go().
			KoBuildAndScan(ctx, src, token)
}

searchVulnerabilities() 🔗

SearchVulnerabilities parses the Trivy scan report and filters vulnerabilities by severity

Return Type
[String ! ] !
Arguments
NameTypeDefault ValueDescription
scanOutputString !-The scan output as a string
severityFilterString !-Comma-separated list of severities to filter (e.g., "HIGH,CRITICAL")
Example
func (m *myModule) example(ctx context.Context, scanOutput string, severityFilter string) []string  {
	return dag.
			Go().
			SearchVulnerabilities(ctx, scanOutput, severityFilter)
}

binary() 🔗

Return Type
Directory !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
goVersionString "1.23.6"No description provided
osString "linux"No description provided
archString "amd64"No description provided
goMainFileString "main.go"No description provided
binNameString "main"No description provided
ldflagsString -Add ldflags as an optional parameter
Example
func (m *myModule) example(src *Directory) *Directory  {
	return dag.
			Go().
			Binary(src)
}

build() 🔗

Return Type
Directory !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
optsBuildOpts !-Use the struct for parameters
Example
func (m *myModule) example(src *Directory, opts *GoBuildOpts) *Directory  {
	return dag.
			Go().
			Build(src, opts)
}

koBuild() 🔗

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
tokenNameString "GITHUB_TOKEN"No description provided
tokenSecret !-No description provided
repoString "ko.local"No description provided
buildArgString "."No description provided
koVersionString "v0.17.1"No description provided
pushString "true"No description provided
Example
func (m *myModule) example(ctx context.Context, src *Directory, token *Secret) string  {
	return dag.
			Go().
			KoBuild(ctx, src, token)
}

test() 🔗

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
goVersionString !-Go version to use for testing
testArgString "./..."Arguments for `go test`
Example
func (m *myModule) example(ctx context.Context, src *Directory, goVersion string) string  {
	return dag.
			Go().
			Test(ctx, src, goVersion)
}

trivyScan() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
severityString "HIGH,CRITICAL"Severity levels to include (e.g., "HIGH,CRITICAL")
trivyVersionString "0.59.1"No description provided
Example
func (m *myModule) example(src *Directory) *File  {
	return dag.
			Go().
			TrivyScan(src)
}

securityScan() 🔗

Return Type
File !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
secureGoVersionString "2.22.1"No description provided
Example
func (m *myModule) example(src *Directory) *File  {
	return dag.
			Go().
			SecurityScan(src)
}

runWorkflowContainerStage() 🔗

Return Type
String !
Arguments
NameTypeDefault ValueDescription
srcDirectory !-No description provided
tokenNameString "GITHUB_TOKEN"No description provided
tokenSecret !-No description provided
repoString "ko.local"No description provided
buildArgString "."No description provided
koVersionString "v0.17.1"No description provided
pushString "true"No description provided
severityFilterString "HIGH,CRITICAL"Comma-separated list of severities to filter (e.g., "HIGH,CRITICAL")
Example
func (m *myModule) example(ctx context.Context, src *Directory, token *Secret) string  {
	return dag.
			Go().
			RunWorkflowContainerStage(ctx, src, token)
}

scanRemoteImage() 🔗

Return Type
String !
Arguments
NameTypeDefault ValueDescription
imageAddressString !-Remote image address (e.g., "ko.local/my-image:latest")
severityFilterString !-Comma-separated list of severities to filter (e.g., "HIGH,CRITICAL")
Example
func (m *myModule) example(ctx context.Context, imageAddress string, severityFilter string) string  {
	return dag.
			Go().
			ScanRemoteImage(ctx, imageAddress, severityFilter)
}

BuildOpts 🔗

goVersion() 🔗

Return Type
String !
Example
Function GoBuildOpts.goVersion is not accessible from the go module

os() 🔗

Return Type
String !
Example
Function GoBuildOpts.os is not accessible from the go module

arch() 🔗

Return Type
String !
Example
Function GoBuildOpts.arch is not accessible from the go module

goMainFile() 🔗

Return Type
String !
Example
Function GoBuildOpts.goMainFile is not accessible from the go module

binName() 🔗

Return Type
String !
Example
Function GoBuildOpts.binName is not accessible from the go module

ldflags() 🔗

Add this field for linker flags

Return Type
String !
Example
Function GoBuildOpts.ldflags is not accessible from the go module