Dagger
Search

runme

No long description provided.

Installation

dagger install github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188

Entrypoint

Return Type 
Runme !
Arguments
NameTypeDefault ValueDescription
ghcrUsernameString -GhcrUsername is the GitHub Container Registry username for authentication
ghcrTokenSecret -GhcrToken is the GitHub Container Registry token for authentication
targetPlatformString -TargetPlatform specifies the target platform (os/arch combination) for the build
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \

func (m *myModule) example() *dagger.Runme  {
	return dag.
			Runme()
}
@function
def example() -> dagger.Runme:
	return (
		dag.runme()
	)
@func()
example(): Runme {
	return dag
		.runme()
}

Types

Runme 🔗

A Dagger module for Runme

ghcrUsername() 🔗

GhcrUsername is the GitHub Container Registry username for authentication

Return Type 
String !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 ghcr-username
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Runme().
			GhcrUsername(ctx)
}
@function
async def example() -> str:
	return await (
		dag.runme()
		.ghcr_username()
	)
@func()
async example(): Promise<string> {
	return dag
		.runme()
		.ghcrUsername()
}

ghcrToken() 🔗

GhcrToken is the GitHub Container Registry token for authentication

Return Type 
Secret !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 ghcr-token
func (m *myModule) example() *dagger.Secret  {
	return dag.
			Runme().
			GhcrToken()
}
@function
def example() -> dagger.Secret:
	return (
		dag.runme()
		.ghcr_token()
	)
@func()
example(): Secret {
	return dag
		.runme()
		.ghcrToken()
}

source() 🔗

Source is the local source directory for building Runme

Return Type 
Directory !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 source
func (m *myModule) example() *dagger.Directory  {
	return dag.
			Runme().
			Source()
}
@function
def example() -> dagger.Directory:
	return (
		dag.runme()
		.source()
	)
@func()
example(): Directory {
	return dag
		.runme()
		.source()
}

targetOs() 🔗

TargetOS specifies the target operating system for the build

Return Type 
String !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 target-os
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Runme().
			TargetOs(ctx)
}
@function
async def example() -> str:
	return await (
		dag.runme()
		.target_os()
	)
@func()
async example(): Promise<string> {
	return dag
		.runme()
		.targetOs()
}

targetArch() 🔗

TargetArch specifies the target architecture for the build

Return Type 
String !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 target-arch
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Runme().
			TargetArch(ctx)
}
@function
async def example() -> str:
	return await (
		dag.runme()
		.target_arch()
	)
@func()
async example(): Promise<string> {
	return dag
		.runme()
		.targetArch()
}

targetPlatform() 🔗

TargetPlatform returns the target platform in the format “OS/ARCH”.

Return Type 
String !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 target-platform
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Runme().
			TargetPlatform(ctx)
}
@function
async def example() -> str:
	return await (
		dag.runme()
		.target_platform()
	)
@func()
async example(): Promise<string> {
	return dag
		.runme()
		.targetPlatform()
}

withSource() 🔗

WithSource sets the source directory for the Runme module and returns the module for method chaining.

Return Type 
Runme !
Arguments
NameTypeDefault ValueDescription
sourceDirectory !-No description provided
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 with-source --source DIR_PATH
func (m *myModule) example(source *dagger.Directory) *dagger.Runme  {
	return dag.
			Runme().
			WithSource(source)
}
@function
def example(source: dagger.Directory) -> dagger.Runme:
	return (
		dag.runme()
		.with_source(source)
	)
@func()
example(source: Directory): Runme {
	return dag
		.runme()
		.withSource(source)
}

container() 🔗

Container creates a container with Runme source and registry auth.

Return Type 
Container !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 container
func (m *myModule) example() *dagger.Container  {
	return dag.
			Runme().
			Container()
}
@function
def example() -> dagger.Container:
	return (
		dag.runme()
		.container()
	)
@func()
example(): Container {
	return dag
		.runme()
		.container()
}

build() 🔗

Build compiles the Runme binary for the target OS and architecture specified in the module and returns the container with the built binary.

Return Type 
Container !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 build
func (m *myModule) example() *dagger.Container  {
	return dag.
			Runme().
			Build()
}
@function
def example() -> dagger.Container:
	return (
		dag.runme()
		.build()
	)
@func()
example(): Container {
	return dag
		.runme()
		.build()
}

binary() 🔗

Binary returns the Runme binary as a file.

Return Type 
File !
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 binary
func (m *myModule) example() *dagger.File  {
	return dag.
			Runme().
			Binary()
}
@function
def example() -> dagger.File:
	return (
		dag.runme()
		.binary()
	)
@func()
example(): File {
	return dag
		.runme()
		.binary()
}

test() 🔗

Test runs the test suite for Runme and returns the container with test results.

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
pkgsString !"./..."pkgs is an optional golang package name to narrow down the test suite
Example
dagger -m github.com/runmedev/runme@2d8ba45fb31468055c5348a4c4ff2d5e8984a188 call \
 test --pkgs string
func (m *myModule) example(pkgs string) *dagger.Container  {
	return dag.
			Runme().
			Test(pkgs)
}
@function
def example(pkgs: str) -> dagger.Container:
	return (
		dag.runme()
		.test(pkgs)
	)
@func()
example(pkgs: string): Container {
	return dag
		.runme()
		.test(pkgs)
}