greetings
Installation
Entrypoint
Types
Greetings

greetings

No long description provided.

Installation

dagger install github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba

Entrypoint

Return Type

Greetings

Example

dagger -m github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba 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
dir	Directory !	-	No description provided

Example

dagger -m github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 test --dir DIR_PATH

func (m *myModule) example(ctx context.Context, dir *Directory) string  {
	return dag.
			Greetings().
			Test(ctx, dir)
}

@function
async def example(dir: dagger.Directory) -> str:
	return await (
		dag.greetings()
		.test(dir)
	)

@func()
async example(dir: Directory): Promise<string> {
	return dag
		.greetings()
		.test(dir)
}

lint() 🔗

Lint the Go code in the project

Return Type

String !

Arguments

Name	Type	Default Value	Description
dir	Directory !	-	No description provided

Example

dagger -m github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 lint --dir DIR_PATH

func (m *myModule) example(ctx context.Context, dir *Directory) string  {
	return dag.
			Greetings().
			Lint(ctx, dir)
}

@function
async def example(dir: dagger.Directory) -> str:
	return await (
		dag.greetings()
		.lint(dir)
	)

@func()
async example(dir: Directory): Promise<string> {
	return dag
		.greetings()
		.lint(dir)
}

build() 🔗

Build the backend and frontend for a specified environment

Return Type

Directory !

Arguments

Name	Type	Default Value	Description
dir	Directory !	-	No description provided
env	String !	-	No description provided

Example

dagger -m github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 build --dir DIR_PATH --env string

func (m *myModule) example(dir *Directory, env string) *Directory  {
	return dag.
			Greetings().
			Build(dir, env)
}

@function
def example(dir: dagger.Directory, env: str) -> dagger.Directory:
	return (
		dag.greetings()
		.build(dir, env)
	)

@func()
example(dir: Directory, env: string): Directory {
	return dag
		.greetings()
		.build(dir, env)
}

serve() 🔗

Serve the backend and frontend to 8080 and 8081 respectively

Return Type

Service !

Arguments

Name	Type	Default Value	Description
dir	Directory !	-	No description provided

Example

dagger -m github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 serve --dir DIR_PATH

func (m *myModule) example(dir *Directory) *Service  {
	return dag.
			Greetings().
			Serve(dir)
}

@function
def example(dir: dagger.Directory) -> dagger.Service:
	return (
		dag.greetings()
		.serve(dir)
	)

@func()
example(dir: Directory): Service {
	return dag
		.greetings()
		.serve(dir)
}

release() 🔗

Create a GitHub release

Return Type

String !

Arguments

Name	Type	Default Value	Description
dir	Directory !	-	No description provided
tag	String !	-	No description provided
ghToken	Secret !	-	No description provided

Example

dagger -m github.com/kpenfound/greetings-api@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 release --dir DIR_PATH --tag string --gh-token env:MYSECRET

func (m *myModule) example(ctx context.Context, dir *Directory, tag string, ghToken *Secret) string  {
	return dag.
			Greetings().
			Release(ctx, dir, tag, ghToken)
}

@function
async def example(dir: dagger.Directory, tag: str, gh_token: dagger.Secret) -> str:
	return await (
		dag.greetings()
		.release(dir, tag, gh_token)
	)

@func()
async example(dir: Directory, tag: string, ghToken: Secret): Promise<string> {
	return dag
		.greetings()
		.release(dir, tag, ghToken)
}

deploy() 🔗

Deploy the project to fly and netlify

Return Type

String !

Arguments

Name	Type	Default Value	Description
dir	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@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 deploy --dir DIR_PATH --fly-token env:MYSECRET --netlify-token env:MYSECRET --registry-user string --registry-pass env:MYSECRET

func (m *myModule) example(ctx context.Context, dir *Directory, flyToken *Secret, netlifyToken *Secret, registryUser string, registryPass *Secret) string  {
	return dag.
			Greetings().
			Deploy(ctx, dir, flyToken, netlifyToken, registryUser, registryPass)
}

@function
async def example(dir: dagger.Directory, fly_token: dagger.Secret, netlify_token: dagger.Secret, registry_user: str, registry_pass: dagger.Secret) -> str:
	return await (
		dag.greetings()
		.deploy(dir, fly_token, netlify_token, registry_user, registry_pass)
	)

@func()
async example(dir: Directory, flyToken: Secret, netlifyToken: Secret, registryUser: string, registryPass: Secret): Promise<string> {
	return dag
		.greetings()
		.deploy(dir, flyToken, netlifyToken, registryUser, registryPass)
}

ci() 🔗

Run the whole CI pipeline

Return Type

String !

Arguments

Name	Type	Default Value	Description
dir	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@9cf1892651be8dcde985b0a4573ada7a79fbb0ba call \
 ci --dir DIR_PATH

func (m *myModule) example(ctx context.Context, dir *Directory) string  {
	return dag.
			Greetings().
			Ci(ctx, dir)
}

@function
async def example(dir: dagger.Directory) -> str:
	return await (
		dag.greetings()
		.ci(dir)
	)

@func()
async example(dir: Directory): Promise<string> {
	return dag
		.greetings()
		.ci(dir)
}