greetings
No long description provided.
Installation
dagger install github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba
Entrypoint
Return Type
Greetings
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba 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 🔗
test() 🔗
Run unit tests for the project
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
test --source DIR_PATH
func (m *myModule) example(ctx context.Context, source *Directory) string {
return dag.
Greetings().
Test(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
return await (
dag.greetings()
.test(source)
)
@func()
async example(source: Directory): Promise<string> {
return dag
.greetings()
.test(source)
}
lint() 🔗
Lint the Go code in the project
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
lint --source DIR_PATH
func (m *myModule) example(ctx context.Context, source *Directory) string {
return dag.
Greetings().
Lint(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
return await (
dag.greetings()
.lint(source)
)
@func()
async example(source: Directory): Promise<string> {
return dag
.greetings()
.lint(source)
}
build() 🔗
Build the backend and frontend for a specified environment
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
env | String ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
build --source DIR_PATH --env string
func (m *myModule) example(source *Directory, env string) *Directory {
return dag.
Greetings().
Build(source, env)
}
@function
def example(source: dagger.Directory, env: str) -> dagger.Directory:
return (
dag.greetings()
.build(source, env)
)
@func()
example(source: Directory, env: string): Directory {
return dag
.greetings()
.build(source, env)
}
serve() 🔗
Serve the backend and frontend to 8080 and 8081 respectively
Return Type
Service !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
serve --source DIR_PATH
func (m *myModule) example(source *Directory) *Service {
return dag.
Greetings().
Serve(source)
}
@function
def example(source: dagger.Directory) -> dagger.Service:
return (
dag.greetings()
.serve(source)
)
@func()
example(source: Directory): Service {
return dag
.greetings()
.serve(source)
}
release() 🔗
Create a GitHub release
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
tag | String ! | - | No description provided |
ghToken | Secret ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
release --source DIR_PATH --tag string --gh-token env:MYSECRET
func (m *myModule) example(ctx context.Context, source *Directory, tag string, ghToken *Secret) string {
return dag.
Greetings().
Release(ctx, source, tag, ghToken)
}
@function
async def example(source: dagger.Directory, tag: str, gh_token: dagger.Secret) -> str:
return await (
dag.greetings()
.release(source, tag, gh_token)
)
@func()
async example(source: Directory, tag: string, ghToken: Secret): Promise<string> {
return dag
.greetings()
.release(source, tag, ghToken)
}
deploy() 🔗
Deploy the project to fly and netlify
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
flyToken | Secret ! | - | No description provided |
netlifyToken | Secret ! | - | No description provided |
registryUser | String ! | - | No description provided |
registryPass | Secret ! | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
deploy --source DIR_PATH --fly-token env:MYSECRET --netlify-token env:MYSECRET --registry-user string --registry-pass env:MYSECRET
func (m *myModule) example(ctx context.Context, source *Directory, flyToken *Secret, netlifyToken *Secret, registryUser string, registryPass *Secret) string {
return dag.
Greetings().
Deploy(ctx, source, flyToken, netlifyToken, registryUser, registryPass)
}
@function
async def example(source: dagger.Directory, fly_token: dagger.Secret, netlify_token: dagger.Secret, registry_user: str, registry_pass: dagger.Secret) -> str:
return await (
dag.greetings()
.deploy(source, fly_token, netlify_token, registry_user, registry_pass)
)
@func()
async example(source: Directory, flyToken: Secret, netlifyToken: Secret, registryUser: string, registryPass: Secret): Promise<string> {
return dag
.greetings()
.deploy(source, flyToken, netlifyToken, registryUser, registryPass)
}
all() 🔗
Run the whole CI pipeline
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
source | Directory ! | - | No description provided |
release | Boolean | - | No description provided |
tag | String | - | No description provided |
infisicalToken | Secret | - | No description provided |
infisicalProject | String | - | No description provided |
Example
dagger -m github.com/kpenfound/greetings-api@08fc0aef402faf8d82361c6cc570d4609a1af6ba call \
all --source DIR_PATH
func (m *myModule) example(ctx context.Context, source *Directory) string {
return dag.
Greetings().
All(ctx, source)
}
@function
async def example(source: dagger.Directory) -> str:
return await (
dag.greetings()
.all(source)
)
@func()
async example(source: Directory): Promise<string> {
return dag
.greetings()
.all(source)
}