elixir-sdk-dev
Installation
Entrypoint
Types
ElixirSdkDev

elixir-sdk-dev

Develop the Dagger Elixir SDK (experimental)

Installation

dagger install github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe

Entrypoint

Return Type

ElixirSdkDev !

Arguments

Name	Type	Default Value	Description
baseImage	String	-	No description provided
workspace	Directory	-	No description provided
sourcePath	String	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \

func (m *MyModule) Example() *dagger.ElixirSdkDev  {
	return dag.
			ElixirSdkDev()
}

@function
def example() -> dagger.ElixirSdkDev:
	return (
		dag.elixir_sdk_dev()
	)

@func()
example(): ElixirSdkDev {
	return dag
		.elixirSdkDev()
}

Types

ElixirSdkDev 🔗

baseImage() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 base-image

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			ElixirSdkDev().
			BaseImage(ctx)
}

@function
async def example() -> str:
	return await (
		dag.elixir_sdk_dev()
		.base_image()
	)

@func()
async example(): Promise<string> {
	return dag
		.elixirSdkDev()
		.baseImage()
}

workspace() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 workspace

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			ElixirSdkDev().
			Workspace()
}

@function
def example() -> dagger.Directory:
	return (
		dag.elixir_sdk_dev()
		.workspace()
	)

@func()
example(): Directory {
	return dag
		.elixirSdkDev()
		.workspace()
}

sourcePath() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 source-path

func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			ElixirSdkDev().
			SourcePath(ctx)
}

@function
async def example() -> str:
	return await (
		dag.elixir_sdk_dev()
		.source_path()
	)

@func()
async example(): Promise<string> {
	return dag
		.elixirSdkDev()
		.sourcePath()
}

sdkTest() 🔗

Run the SDK tests

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 sdk-test

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			ElixirSdkDev().
			SdkTest(ctx)
}

@function
async def example() -> None:
	return await (
		dag.elixir_sdk_dev()
		.sdk_test()
	)

@func()
async example(): Promise<void> {
	return dag
		.elixirSdkDev()
		.sdkTest()
}

codegenTest() 🔗

Run dagger_codegen tests

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 codegen-test

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			ElixirSdkDev().
			CodegenTest(ctx)
}

@function
async def example() -> None:
	return await (
		dag.elixir_sdk_dev()
		.codegen_test()
	)

@func()
async example(): Promise<void> {
	return dag
		.elixirSdkDev()
		.codegenTest()
}

releaseDryRun() 🔗

Test the publishing process

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 release-dry-run

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			ElixirSdkDev().
			ReleaseDryRun(ctx)
}

@function
async def example() -> None:
	return await (
		dag.elixir_sdk_dev()
		.release_dry_run()
	)

@func()
async example(): Promise<void> {
	return dag
		.elixirSdkDev()
		.releaseDryRun()
}

publish() 🔗

Publish the Elixir SDK

Return Type

Void !

Arguments

Name	Type	Default Value	Description
tag	String !	-	No description provided
hexApiKey	Secret !	-	No description provided
dryRun	Boolean	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 publish --tag string --hex-api-key env:MYSECRET

func (m *MyModule) Example(ctx context.Context, tag string, hexApiKey *dagger.Secret)   {
	return dag.
			ElixirSdkDev().
			Publish(ctx, tag, hexApiKey)
}

@function
async def example(tag: str, hex_api_key: dagger.Secret) -> None:
	return await (
		dag.elixir_sdk_dev()
		.publish(tag, hex_api_key)
	)

@func()
async example(tag: string, hexApiKey: Secret): Promise<void> {
	return dag
		.elixirSdkDev()
		.publish(tag, hexApiKey)
}

source() 🔗

Return Type

Directory !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 source

func (m *MyModule) Example() *dagger.Directory  {
	return dag.
			ElixirSdkDev().
			Source()
}

@function
def example() -> dagger.Directory:
	return (
		dag.elixir_sdk_dev()
		.source()
	)

@func()
example(): Directory {
	return dag
		.elixirSdkDev()
		.source()
}

devContainer() 🔗

Return Type

Container !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 dev-container

func (m *MyModule) Example() *dagger.Container  {
	return dag.
			ElixirSdkDev().
			DevContainer()
}

@function
def example() -> dagger.Container:
	return (
		dag.elixir_sdk_dev()
		.dev_container()
	)

@func()
example(): Container {
	return dag
		.elixirSdkDev()
		.devContainer()
}

bump() 🔗

Bump the Elixir SDK’s Engine dependency

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
version	String !	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 bump --version string

func (m *MyModule) Example(version string) *dagger.Changeset  {
	return dag.
			ElixirSdkDev().
			Bump(version)
}

@function
def example(version: str) -> dagger.Changeset:
	return (
		dag.elixir_sdk_dev()
		.bump(version)
	)

@func()
example(version: string): Changeset {
	return dag
		.elixirSdkDev()
		.bump(version)
}

syncImage() 🔗

Sync Elixir image to keep both dev and runtime modules consistent

Return Type

File !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 sync-image

func (m *MyModule) Example() *dagger.File  {
	return dag.
			ElixirSdkDev().
			SyncImage()
}

@function
def example() -> dagger.File:
	return (
		dag.elixir_sdk_dev()
		.sync_image()
	)

@func()
example(): File {
	return dag
		.elixirSdkDev()
		.syncImage()
}

test() 🔗

Test the SDK

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 test

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			ElixirSdkDev().
			Test(ctx)
}

@function
async def example() -> None:
	return await (
		dag.elixir_sdk_dev()
		.test()
	)

@func()
async example(): Promise<void> {
	return dag
		.elixirSdkDev()
		.test()
}

lint() 🔗

Lint the SDK

Return Type

Void !

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 lint

func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			ElixirSdkDev().
			Lint(ctx)
}

@function
async def example() -> None:
	return await (
		dag.elixir_sdk_dev()
		.lint()
	)

@func()
async example(): Promise<void> {
	return dag
		.elixirSdkDev()
		.lint()
}

generate() 🔗

Regenerate the Elixir SDK API

Return Type

Changeset !

Arguments

Name	Type	Default Value	Description
introspectionJson	File !	-	No description provided

Example

dagger -m github.com/shykes/dagger/toolchains/elixir-sdk-dev@7ec44c64b509793d2a722ebdfef94a77dbcdcefe call \
 generate --introspection-json file:path

func (m *MyModule) Example(introspectionJson *dagger.File) *dagger.Changeset  {
	return dag.
			ElixirSdkDev().
			Generate(introspectionJson)
}

@function
def example(introspection_json: dagger.File) -> dagger.Changeset:
	return (
		dag.elixir_sdk_dev()
		.generate(introspection_json)
	)

@func()
example(introspectionJson: File): Changeset {
	return dag
		.elixirSdkDev()
		.generate(introspectionJson)
}