melange
This module has been generated via dagger init and serves as a reference tobasic 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 types 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/opopops/daggerverse/melange@v1.3.5
Entrypoint
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
image | String ! | "cgr.dev/chainguard/wolfi-base:latest" | Melange image |
version | String | null | No description provided |
registryUsername | String | null | No description provided |
registryPassword | Secret | null | No description provided |
user | String | "0" | No description provided |
container | Container | null | No description provided |
signingKey | File | null | No description provided |
publicKey | File | null | No description provided |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string
func (m *myModule) example(image string) *Melange {
return dag.
Melange(image)
}
@function
def example(image: str, ) -> dag.Melange:
return (
dag.melange(image)
)
@func()
example(image: string, ): Melange {
return dag
.melange(image)
}
Types
Melange 🔗
image() 🔗
Melange image
Return Type
String !
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string image
func (m *myModule) example(ctx context.Context, image string) string {
return dag.
Melange(image).
Image(ctx)
}
@function
async def example(image: str, ) -> str:
return await (
dag.melange(image)
.image()
)
@func()
async example(image: string, ): Promise<string> {
return dag
.melange(image)
.image()
}
version() 🔗
Return Type
String
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string version
func (m *myModule) example(ctx context.Context, image string) string {
return dag.
Melange(image).
Version(ctx)
}
@function
async def example(image: str, ) -> str:
return await (
dag.melange(image)
.version()
)
@func()
async example(image: string, ): Promise<string> {
return dag
.melange(image)
.version()
}
registryUsername() 🔗
Return Type
String
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string registry-username
func (m *myModule) example(ctx context.Context, image string) string {
return dag.
Melange(image).
RegistryUsername(ctx)
}
@function
async def example(image: str, ) -> str:
return await (
dag.melange(image)
.registry_username()
)
@func()
async example(image: string, ): Promise<string> {
return dag
.melange(image)
.registryUsername()
}
registryPassword() 🔗
Return Type
Secret
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string registry-password
func (m *myModule) example(image string) *Secret {
return dag.
Melange(image).
RegistryPassword()
}
@function
def example(image: str, ) -> dagger.Secret:
return (
dag.melange(image)
.registry_password()
)
@func()
example(image: string, ): Secret {
return dag
.melange(image)
.registryPassword()
}
user() 🔗
Return Type
String
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string user
func (m *myModule) example(ctx context.Context, image string) string {
return dag.
Melange(image).
User(ctx)
}
@function
async def example(image: str, ) -> str:
return await (
dag.melange(image)
.user()
)
@func()
async example(image: string, ): Promise<string> {
return dag
.melange(image)
.user()
}
build() 🔗
Build a package from a YAML configuration file
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
config | File ! | - | Config file |
version | String | null | No description provided |
sourceDir | Directory | null | No description provided |
signingKey | File | null | No description provided |
arch | String | null | No description provided |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string build --config file:path
func (m *myModule) example(image string, config *File) *Directory {
return dag.
Melange(image).
Build(config)
}
@function
def example(image: str, config: dagger.File) -> dagger.Directory:
return (
dag.melange(image)
.build(config)
)
@func()
example(image: string, config: File): Directory {
return dag
.melange(image)
.build(config)
}
bump() 🔗
Update a Melange YAML file to reflect a new package version
Return Type
File !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
config | File ! | - | Config file |
version | String ! | - | Version to bump to |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string bump --config file:path --version string
func (m *myModule) example(image string, config *File, version string) *File {
return dag.
Melange(image).
Bump(config, version)
}
@function
def example(image: str, config: dagger.File, version: str) -> dagger.File:
return (
dag.melange(image)
.bump(config, version)
)
@func()
example(image: string, config: File, version: string): File {
return dag
.melange(image)
.bump(config, version)
}
container() 🔗
Returns container
Return Type
Container !
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string container
func (m *myModule) example(image string) *Container {
return dag.
Melange(image).
Container()
}
@function
def example(image: str, ) -> dagger.Container:
return (
dag.melange(image)
.container()
)
@func()
example(image: string, ): Container {
return dag
.melange(image)
.container()
}
keygen() 🔗
Generate a key for package signing
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
keySize | Integer ! | 4096 | the size of the prime to calculate |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string keygen --key-size integer
func (m *myModule) example(image string, keySize int) *Directory {
return dag.
Melange(image).
Keygen(keySize)
}
@function
def example(image: str, key_size: int) -> dagger.Directory:
return (
dag.melange(image)
.keygen(key_size)
)
@func()
example(image: string, keySize: number): Directory {
return dag
.melange(image)
.keygen(keySize)
}
publicKey() 🔗
Return the generated public key
Return Type
File !
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string public-key
func (m *myModule) example(image string) *File {
return dag.
Melange(image).
PublicKey()
}
@function
def example(image: str, ) -> dagger.File:
return (
dag.melange(image)
.public_key()
)
@func()
example(image: string, ): File {
return dag
.melange(image)
.publicKey()
}
signingKey() 🔗
Return the generated signing key
Return Type
File !
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string signing-key
func (m *myModule) example(image string) *File {
return dag.
Melange(image).
SigningKey()
}
@function
def example(image: str, ) -> dagger.File:
return (
dag.melange(image)
.signing_key()
)
@func()
example(image: string, ): File {
return dag
.melange(image)
.signingKey()
}
withBuild() 🔗
Build a package from a YAML configuration file (for chaining)
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
config | File ! | - | Config file |
version | String | null | No description provided |
signingKey | File | null | No description provided |
arch | String | null | No description provided |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string with-build --config file:path
func (m *myModule) example(image string, config *File) *Melange {
return dag.
Melange(image).
WithBuild(config)
}
@function
def example(image: str, config: dagger.File) -> dag.Melange:
return (
dag.melange(image)
.with_build(config)
)
@func()
example(image: string, config: File): Melange {
return dag
.melange(image)
.withBuild(config)
}
withBump() 🔗
Update a Melange YAML file to reflect a new package version for chaining
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
config | File ! | - | Config file |
version | String ! | - | Version to bump to |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string with-bump --config file:path --version string
func (m *myModule) example(image string, config *File, version string) *Melange {
return dag.
Melange(image).
WithBump(config, version)
}
@function
def example(image: str, config: dagger.File, version: str) -> dag.Melange:
return (
dag.melange(image)
.with_bump(config, version)
)
@func()
example(image: string, config: File, version: string): Melange {
return dag
.melange(image)
.withBump(config, version)
}
withKeygen() 🔗
Generate a key for package signing for chaining
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
keySize | Integer ! | 4096 | the size of the prime to calculate |
Example
dagger -m github.com/opopops/daggerverse/melange@078d3e017bd37e1efc26da3ac41c11cbfe8a1829 call \
--image string with-keygen --key-size integer
func (m *myModule) example(image string, keySize int) *Melange {
return dag.
Melange(image).
WithKeygen(keySize)
}
@function
def example(image: str, key_size: int) -> dag.Melange:
return (
dag.melange(image)
.with_keygen(key_size)
)
@func()
example(image: string, keySize: number): Melange {
return dag
.melange(image)
.withKeygen(keySize)
}