Dagger
Search

vercel

Vercel module provides a simple way to deploy, list and remove deployments from vercel

Installation

dagger install github.com/slumbering/daggerverse/vercel@v0.1.0

Entrypoint

Return Type
Options !
Arguments
NameTypeDescription
currentWorkdirDirectory !No description provided
tokenSecret !No description provided
deploymentUrlString No description provided
Example
Function Options.Constructor is not accessible from the vercel module
Function Options.Constructor is not accessible from the vercel module
Function Options.Constructor is not accessible from the vercel module

Entrypoint

Return Type
Vercel
Example
func (m *myModule) example() *Vercel  {
	return dag.
			Vercel()
}
@function
def example() -> dag.Vercel:
	return (
		dag.vercel()
	)
@func()
example(): Vercel {
	return dag
		.vercel()
}

Types

Options

currentWorkdir()

Return Type
Directory !
Example
Function VercelOptions.currentWorkdir is not accessible from the vercel module
Function VercelOptions.currentWorkdir is not accessible from the vercel module
Function VercelOptions.currentWorkdir is not accessible from the vercel module
Function VercelOptions.currentWorkdir is not accessible from the vercel module

token()

Return Type
Secret !
Example
Function VercelOptions.token is not accessible from the vercel module
Function VercelOptions.token is not accessible from the vercel module
Function VercelOptions.token is not accessible from the vercel module
Function VercelOptions.token is not accessible from the vercel module

deploymentUrl()

Return Type
String !
Example
Function VercelOptions.deploymentUrl is not accessible from the vercel module
Function VercelOptions.deploymentUrl is not accessible from the vercel module
Function VercelOptions.deploymentUrl is not accessible from the vercel module
Function VercelOptions.deploymentUrl is not accessible from the vercel module

base()

Return Type
Container !
Example
Function VercelOptions.base is not accessible from the vercel module
Function VercelOptions.base is not accessible from the vercel module
Function VercelOptions.base is not accessible from the vercel module
Function VercelOptions.base is not accessible from the vercel module

Vercel

vercelDeploy()

Deploy the current directory to vercel

Return Type
String !
Arguments
NameTypeDefault ValueDescription
currentWorkdirDirectory !-path to the directory to deploy
tokenSecret !-vercel token
Example
dagger -m github.com/slumbering/daggerverse/vercel@8d4e63ba7ffbea152baa10e9996e9ab75854f61c call \
 vercel-deploy --current-workdir DIR_PATH --token env:MYSECRET
func (m *myModule) example(ctx context.Context, currentWorkdir *Directory, token *Secret) string  {
	return dag.
			Vercel().
			VercelDeploy(ctx, currentWorkdir, token)
}
@function
async def example(current_workdir: dagger.Directory, token: dagger.Secret) -> str:
	return await (
		dag.vercel()
		.vercel_deploy(current_workdir, token)
	)
@func()
async example(currentWorkdir: Directory, token: Secret): Promise<string> {
	return dag
		.vercel()
		.vercelDeploy(currentWorkdir, token)
}

vercelList()

List all deployments in vercel

Return Type
String !
Arguments
NameTypeDefault ValueDescription
currentWorkdirDirectory !-path of the directory to list deployments
tokenSecret !-vercel token
Example
dagger -m github.com/slumbering/daggerverse/vercel@8d4e63ba7ffbea152baa10e9996e9ab75854f61c call \
 vercel-list --current-workdir DIR_PATH --token env:MYSECRET
func (m *myModule) example(ctx context.Context, currentWorkdir *Directory, token *Secret) string  {
	return dag.
			Vercel().
			VercelList(ctx, currentWorkdir, token)
}
@function
async def example(current_workdir: dagger.Directory, token: dagger.Secret) -> str:
	return await (
		dag.vercel()
		.vercel_list(current_workdir, token)
	)
@func()
async example(currentWorkdir: Directory, token: Secret): Promise<string> {
	return dag
		.vercel()
		.vercelList(currentWorkdir, token)
}

vercelRemove()

Remove a deployment from vercel

Return Type
String !
Arguments
NameTypeDefault ValueDescription
currentWorkdirDirectory !-path of the directory to remove deployment
deploymentUrlString !-URL of the deployment to remove
tokenSecret !-vercel token
Example
dagger -m github.com/slumbering/daggerverse/vercel@8d4e63ba7ffbea152baa10e9996e9ab75854f61c call \
 vercel-remove --current-workdir DIR_PATH --deployment-url string --token env:MYSECRET
func (m *myModule) example(ctx context.Context, currentWorkdir *Directory, deploymentUrl string, token *Secret) string  {
	return dag.
			Vercel().
			VercelRemove(ctx, currentWorkdir, deploymentUrl, token)
}
@function
async def example(current_workdir: dagger.Directory, deployment_url: str, token: dagger.Secret) -> str:
	return await (
		dag.vercel()
		.vercel_remove(current_workdir, deployment_url, token)
	)
@func()
async example(currentWorkdir: Directory, deploymentUrl: string, token: Secret): Promise<string> {
	return dag
		.vercel()
		.vercelRemove(currentWorkdir, deploymentUrl, token)
}