greetings
No long description provided.
Installation
dagger install github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d
Entrypoint
Return Type
Greetings !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory | - | No description provided |
repo | String | "github.com/kpenfound/greetings-api" | No description provided |
image | String | "kylepenfound/greetings-api:latest" | No description provided |
app | String | "dagger-demo" | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
func (m *myModule) example() *Greetings {
return dag.
Greetings()
}
@function
def example() -> dag.Greetings:
return (
dag.greetings()
)
@func()
example(): Greetings {
return dag
.greetings()
}
Types
Greetings 🔗
check() 🔗
Run the CI Checks for the project
Return Type
String !
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
check
func (m *myModule) example(ctx context.Context) string {
return dag.
Greetings().
Check(ctx)
}
@function
async def example() -> str:
return await (
dag.greetings()
.check()
)
@func()
async example(): Promise<string> {
return dag
.greetings()
.check()
}
test() 🔗
Run unit tests for the project
Return Type
String !
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
test
func (m *myModule) example(ctx context.Context) string {
return dag.
Greetings().
Test(ctx)
}
@function
async def example() -> str:
return await (
dag.greetings()
.test()
)
@func()
async example(): Promise<string> {
return dag
.greetings()
.test()
}
lint() 🔗
Lint the Go code in the project
Return Type
String !
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
lint
func (m *myModule) example(ctx context.Context) string {
return dag.
Greetings().
Lint(ctx)
}
@function
async def example() -> str:
return await (
dag.greetings()
.lint()
)
@func()
async example(): Promise<string> {
return dag
.greetings()
.lint()
}
build() 🔗
Build the backend and frontend for a specified environment
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
env | String | "dev" | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
build
func (m *myModule) example() *Directory {
return dag.
Greetings().
Build()
}
@function
def example() -> dagger.Directory:
return (
dag.greetings()
.build()
)
@func()
example(): Directory {
return dag
.greetings()
.build()
}
serve() 🔗
Serve the backend and frontend to 8080 and 8081 respectively
Return Type
Service !
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
serve
func (m *myModule) example() *Service {
return dag.
Greetings().
Serve()
}
@function
def example() -> dagger.Service:
return (
dag.greetings()
.serve()
)
@func()
example(): Service {
return dag
.greetings()
.serve()
}
release() 🔗
Create a GitHub release
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
tag | String ! | - | No description provided |
ghToken | Secret ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@83153ba66673e9a315520767e4b387953f79643d call \
release --tag string --gh-token env:MYSECRET
func (m *myModule) example(ctx context.Context, tag string, ghToken *Secret) string {
return dag.
Greetings().
Release(ctx, tag, ghToken)
}
@function
async def example(tag: str, gh_token: dagger.Secret) -> str:
return await (
dag.greetings()
.release(tag, gh_token)
)
@func()
async example(tag: string, ghToken: Secret): Promise<string> {
return dag
.greetings()
.release(tag, ghToken)
}