runme
Installation
Entrypoint
Types
Runme

runme

No long description provided.

Installation

dagger install github.com/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c

Entrypoint

Return Type

Runme !

Arguments

Name	Type	Default Value	Description
ghcrUsername	String	-	GhcrUsername is the GitHub Container Registry username for authentication
ghcrToken	Secret	-	GhcrToken is the GitHub Container Registry token for authentication
targetPlatform	String	-	TargetPlatform specifies the target platform (os/arch combination) for the build

Example

dagger -m github.com/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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

Name	Type	Default Value	Description
source	Directory !	-	No description provided

Example

dagger -m github.com/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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

Name	Type	Default Value	Description
pkgs	String !	"./..."	pkgs is an optional golang package name to narrow down the test suite

Example

dagger -m github.com/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c 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)
}

release() 🔗

Release fetches a Runme release from GitHub and returns a directory with the release assets.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
githubToken	Secret	-	GithubToken is an optional authentication token for GitHub API access
version	String	"latest"	Version specifies the release version to fetch, defaults to "latest"

Example

dagger -m github.com/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c call \
 release

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			Runme().
			Release()
}

@function
def example() -> dagger.Directory:
	return (
		dag.runme()
		.release()
	)

@func()
example(): Directory {
	return dag
		.runme()
		.release()
}

releaseFiles() 🔗

ReleaseFiles fetches a Runme release from GitHub and returns a directory with the uncompressed release files.

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
platform	Scalar !	-	Platform specifies the target OS and architecture in the format "os/arch" e.g. "linux/amd64"
githubToken	Secret	-	GithubToken is an optional authentication token for GitHub API access
version	String	"latest"	Version specifies the release version to fetch, defaults to "latest"

Example

dagger -m github.com/stateful/runme@6ef972490b8d1414e5d0f0def8296ab38d6ece0c call \
 release-files

func (m *MyModule) Example(platform ) *dagger.Directory  {
	return dag.
			Runme().
			ReleaseFiles(platform)
}

@function
def example(platform: ) -> dagger.Directory:
	return (
		dag.runme()
		.release_files(platform)
	)

@func()
example(platform: ): Directory {
	return dag
		.runme()
		.releaseFiles(platform)
}