genref
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/cloudnative-pg/daggerverse/genref@ac27cc7677fc42ea129fd3c1aa2b2894aad3a246
Entrypoint
Return Type
Genref !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
genrefVersion | String | "015aaac611407c4fe591bc8700d2c67b7521efca" | genref version to use. renovate: datasource=go depName=github.com/kubernetes-sigs/reference-docs/genref versioning=semver |
goImage | String | "golang:1.24.1-bookworm" | renovate image: datasource=docker depName=golang versioning=docker |
ctr | Container | - | No description provided |
Example
dagger -m github.com/cloudnative-pg/daggerverse/genref@ac27cc7677fc42ea129fd3c1aa2b2894aad3a246 call \
func (m *myModule) example() *Genref {
return dag.
Genref()
}
@function
def example() -> dag.Genref:
return (
dag.genref()
)
@func()
example(): Genref {
return dag
.genref()
}
Types
Genref 🔗
genref() 🔗
Return Type
Container !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | The directory of the repository. |
workDir | String | "docs" | The directory from where the command should run |
args | [String ! ] | - | A list of arguments to pass to genref. |
Example
dagger -m github.com/cloudnative-pg/daggerverse/genref@ac27cc7677fc42ea129fd3c1aa2b2894aad3a246 call \
genref --source DIR_PATH
func (m *myModule) example(source *Directory) *Container {
return dag.
Genref().
Genref(source)
}
@function
def example(source: dagger.Directory) -> dagger.Container:
return (
dag.genref()
.genref(source)
)
@func()
example(source: Directory): Container {
return dag
.genref()
.genref(source)
}