release
Installation
Entrypoint
Types
Release

release

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return rypes using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951

Entrypoint

Return Type

Release !

Arguments

Name	Type	Default Value	Description
src	Directory	-	top level source code directory
lang	String !	-	source code language, e.g. 'go', 'python'.

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string

func (m *MyModule) Example(lang string) *dagger.Release  {
	return dag.
			Release(lang)
}

@function
def example(lang: str) -> dagger.Release:
	return (
		dag.release(lang)
	)

@func()
example(lang: string): Release {
	return dag
		.release(lang)
}

Types

Release 🔗

source() 🔗

Source git repository

Return Type

Directory !

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string source

func (m *MyModule) Example(lang string) *dagger.Directory  {
	return dag.
			Release(lang).
			Source()
}

@function
def example(lang: str) -> dagger.Directory:
	return (
		dag.release(lang)
		.source()
	)

@func()
example(lang: string): Directory {
	return dag
		.release(lang)
		.source()
}

publish() 🔗

Publish creates a release, uploading assets as appropriate.

Return Type

String !

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string publish

func (m *MyModule) Example(ctx context.Context, lang string) string  {
	return dag.
			Release(lang).
			Publish(ctx)
}

@function
async def example(lang: str) -> str:
	return await (
		dag.release(lang)
		.publish()
	)

@func()
async example(lang: string): Promise<string> {
	return dag
		.release(lang)
		.publish()
}

extraTags() 🔗

Generate extra tags based on the provided target tag.

Ex: Given the patch release ‘v1.2.3’, with an existing ‘v1.3.0’ release, it returns ‘v1.2’. Ex: Given the patch release ‘v1.2.3’, which is the latest and greatest, it returns ‘v1’, ‘v1.2’, ‘latest’.

Notice: current issue with SSH AUTH SOCK: https://docs.dagger.io/api/remote-repositories/#multiple-ssh-keys-may-cause-ssh-forwarding-to-fail

Return Type

[String ! ] !

Arguments

Name	Type	Default Value	Description
ref	String !	-	OCI repository, e.g. localhost:5000/helloworld
version	String !	-	target version

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string extra-tags --ref string --version string

func (m *MyModule) Example(ctx context.Context, lang string, ref string, version string) []string  {
	return dag.
			Release(lang).
			ExtraTags(ctx, ref, version)
}

@function
async def example(lang: str, ref: str, version: str) -> List[str]:
	return await (
		dag.release(lang)
		.extra_tags(ref, version)
	)

@func()
async example(lang: string, ref: string, version: string): Promise<string[]> {
	return dag
		.release(lang)
		.extraTags(ref, version)
}

withRegistryAuth() 🔗

Add credentials for a private registry.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
address	String !	-	registry's hostname
username	String !	-	username in registry
secret	Secret !	-	password or token for registry

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string with-registry-auth --address string --username string --secret env:MYSECRET

func (m *MyModule) Example(lang string, address string, username string, secret *dagger.Secret) *dagger.Release  {
	return dag.
			Release(lang).
			WithRegistryAuth(address, username, secret)
}

@function
def example(lang: str, address: str, username: str, secret: dagger.Secret) -> dagger.Release:
	return (
		dag.release(lang)
		.with_registry_auth(address, username, secret)
	)

@func()
example(lang: string, address: string, username: string, secret: Secret): Release {
	return dag
		.release(lang)
		.withRegistryAuth(address, username, secret)
}

withoutRegistryAuth() 🔗

Removes credentials for a private registry.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
address	String !	-	registry's hostname

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string without-registry-auth --address string

func (m *MyModule) Example(lang string, address string) *dagger.Release  {
	return dag.
			Release(lang).
			WithoutRegistryAuth(address)
}

@function
def example(lang: str, address: str) -> dagger.Release:
	return (
		dag.release(lang)
		.without_registry_auth(address)
	)

@func()
example(lang: string, address: string): Release {
	return dag
		.release(lang)
		.withoutRegistryAuth(address)
}

withNetrc() 🔗

Add netrc credentials for a private git repository.

Return Type

Release !

Arguments

Name	Type	Default Value	Description
netrc	Secret !	-	NETRC credentials

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string with-netrc --netrc env:MYSECRET

func (m *MyModule) Example(lang string, netrc *dagger.Secret) *dagger.Release  {
	return dag.
			Release(lang).
			WithNetrc(netrc)
}

@function
def example(lang: str, netrc: dagger.Secret) -> dagger.Release:
	return (
		dag.release(lang)
		.with_netrc(netrc)
	)

@func()
example(lang: string, netrc: Secret): Release {
	return dag
		.release(lang)
		.withNetrc(netrc)
}

version() 🔗

Generate the next version from conventional commit messages (see cliff.toml).

Includes ‘v’ prefix.

Return Type

String !

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string version

func (m *MyModule) Example(ctx context.Context, lang string) string  {
	return dag.
			Release(lang).
			Version(ctx)
}

@function
async def example(lang: str) -> str:
	return await (
		dag.release(lang)
		.version()
	)

@func()
async example(lang: string): Promise<string> {
	return dag
		.release(lang)
		.version()
}

check() 🔗

Check performs sanity checks prior to releasing, i.e. linters and unit tests.

Return Type

String !

Example

dagger -m github.com/act3-ai/dagger/release@7bf7644e904bb42fd78d39e950781ce5426c7951 call \
 --lang string check

func (m *MyModule) Example(ctx context.Context, lang string) string  {
	return dag.
			Release(lang).
			Check(ctx)
}

@function
async def example(lang: str) -> str:
	return await (
		dag.release(lang)
		.check()
	)

@func()
async example(lang: string): Promise<string> {
	return dag
		.release(lang)
		.check()
}