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.8.1
Entrypoint
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
image | String | "cgr.dev/chainguard/wolfi-base:latest" | wolfi-base image |
version | String | "latest" | Melange version |
user | String | "65532" | Image user |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
func (m *MyModule) Example() *dagger.Melange {
return dag.
Melange()
}
@function
def example() -> dagger.Melange:
return (
dag.melange()
)
@func()
example(): Melange {
return dag
.melange()
}
Types
SigningKey 🔗
Signing Key
name() 🔗
Return Type
String
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
signing-key \
name
func (m *MyModule) Example(ctx context.Context) string {
return dag.
Melange().
SigningKey().
Name(ctx)
}
@function
async def example() -> str:
return await (
dag.melange()
.signing_key()
.name()
)
@func()
async example(): Promise<string> {
return dag
.melange()
.signingKey()
.name()
}
private() 🔗
Return Type
Secret
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
signing-key \
private
func (m *MyModule) Example() *dagger.Secret {
return dag.
Melange().
SigningKey().
Private()
}
@function
def example() -> dagger.Secret:
return (
dag.melange()
.signing_key()
.private()
)
@func()
example(): Secret {
return dag
.melange()
.signingKey()
.private()
}
generate() 🔗
Generate a key pair for package signing
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "melange.rsa" | Key name |
size | Integer | 4096 | the size of the prime to calculate |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
signing-key \
generate
func (m *MyModule) Example() *dagger.Directory {
return dag.
Melange().
SigningKey().
Generate()
}
@function
def example() -> dagger.Directory:
return (
dag.melange()
.signing_key()
.generate()
)
@func()
example(): Directory {
return dag
.melange()
.signingKey()
.generate()
}
public() 🔗
Return the public key
Return Type
File !
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
signing-key \
public
func (m *MyModule) Example() *dagger.File {
return dag.
Melange().
SigningKey().
Public()
}
@function
def example() -> dagger.File:
return (
dag.melange()
.signing_key()
.public()
)
@func()
example(): File {
return dag
.melange()
.signingKey()
.public()
}
withGenerate() 🔗
Generate a key pair for package signing for chaining (for testing purpose)
Return Type
SigningKey !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "melange.rsa" | Key name |
size | Integer | 4096 | the size of the prime to calculate |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
signing-key \
with-generate
func (m *MyModule) Example() *dagger.MelangeSigningKey {
return dag.
Melange().
SigningKey().
WithGenerate()
}
@function
def example() -> dagger.MelangeSigningKey:
return (
dag.melange()
.signing_key()
.with_generate()
)
@func()
example(): MelangeSigningKey {
return dag
.melange()
.signingKey()
.withGenerate()
}
Melange 🔗
Melange
build() 🔗
Build a package from a YAML configuration file
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
config | File ! | - | Config file |
version | String | "" | Version to bump to |
sourceDir | Directory | null | Directory used for included sources |
signingKey | Secret | null | Key to use for signing |
arch | [Scalar ! ] | [] | Target architectures |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
build --config file:path
func (m *MyModule) Example(config *dagger.File) *dagger.Directory {
return dag.
Melange().
Build(config)
}
@function
def example(config: dagger.File) -> dagger.Directory:
return (
dag.melange()
.build(config)
)
@func()
example(config: File): Directory {
return dag
.melange()
.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@245d2743ccc4aa6784f913b751478f80a0c85861 call \
bump --config file:path --version string
func (m *MyModule) Example(config *dagger.File, version string) *dagger.File {
return dag.
Melange().
Bump(config, version)
}
@function
def example(config: dagger.File, version: str) -> dagger.File:
return (
dag.melange()
.bump(config, version)
)
@func()
example(config: File, version: string): File {
return dag
.melange()
.bump(config, version)
}
container() 🔗
Returns melange container
Return Type
Container !
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
container
func (m *MyModule) Example() *dagger.Container {
return dag.
Melange().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.melange()
.container()
)
@func()
example(): Container {
return dag
.melange()
.container()
}
keygen() 🔗
Generate a key pair for package signing
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "melange.rsa" | Key name |
keySize | Integer | 4096 | the size of the prime to calculate |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
keygen
func (m *MyModule) Example() *dagger.Directory {
return dag.
Melange().
Keygen()
}
@function
def example() -> dagger.Directory:
return (
dag.melange()
.keygen()
)
@func()
example(): Directory {
return dag
.melange()
.keygen()
}
signingKey() 🔗
Signing key functions
Return Type
SigningKey !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "melange.rsa" | Key name |
private | Secret | null | private key |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
signing-key
func (m *MyModule) Example() *dagger.MelangeSigningKey {
return dag.
Melange().
SigningKey()
}
@function
def example() -> dagger.MelangeSigningKey:
return (
dag.melange()
.signing_key()
)
@func()
example(): MelangeSigningKey {
return dag
.melange()
.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 | "" | Version to bump to |
signingKey | Secret | null | Key to use for signing |
arch | [Scalar ! ] | [] | Target architectures |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
with-build --config file:path
func (m *MyModule) Example(config *dagger.File) *dagger.Melange {
return dag.
Melange().
WithBuild(config)
}
@function
def example(config: dagger.File) -> dagger.Melange:
return (
dag.melange()
.with_build(config)
)
@func()
example(config: File): Melange {
return dag
.melange()
.withBuild(config)
}
withKeygen() 🔗
Generate a key for package signing (for chaining)
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
name | String | "melange.rsa" | Key name |
keySize | Integer | 4096 | the size of the prime to calculate |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
with-keygen
func (m *MyModule) Example() *dagger.Melange {
return dag.
Melange().
WithKeygen()
}
@function
def example() -> dagger.Melange:
return (
dag.melange()
.with_keygen()
)
@func()
example(): Melange {
return dag
.melange()
.withKeygen()
}
withSigningKey() 🔗
Include the specified signing key (for chaining)
Return Type
Melange !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
signingKey | Secret ! | - | Key to use for signing |
name | String | "melange.rsa" | Key name |
Example
dagger -m github.com/opopops/daggerverse/melange@245d2743ccc4aa6784f913b751478f80a0c85861 call \
with-signing-key --signing-key env:MYSECRET
func (m *MyModule) Example(signingKey *dagger.Secret) *dagger.Melange {
return dag.
Melange().
WithSigningKey(signingKey)
}
@function
def example(signing_key: dagger.Secret) -> dagger.Melange:
return (
dag.melange()
.with_signing_key(signing_key)
)
@func()
example(signingKey: Secret): Melange {
return dag
.melange()
.withSigningKey(signingKey)
}