gh-deployment

No long description provided.

Installation

dagger install github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24

Entrypoint

Return Type

GhDeployment

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \

func (m *myModule) example() *GhDeployment  {
	return dag.
			GhDeployment()
}

@function
def example() -> dag.GhDeployment:
	return (
		dag.gh_deployment()
	)

@func()
example(): GhDeployment {
	return dag
		.ghDeployment()
}

Types

GhDeployment 🔗

repository() 🔗

Repository name with owner, for example, “tora/bora”

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 repository

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Repository(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.repository()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.repository()
}

ref() 🔗

Git reference, for example, “refs/heads/main”

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 ref

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Ref(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.ref()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.ref()
}

dockerImageTag() 🔗

Docker Image tag

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 docker-image-tag

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			DockerImageTag(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.docker_image_tag()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.dockerImageTag()
}

application() 🔗

Application name

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 application

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Application(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.application()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.application()
}

stack() 🔗

Stack name

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 stack

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Stack(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.stack()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.stack()
}

environment() 🔗

Environment name, default is “development”

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 environment

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Environment(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.environment()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.environment()
}

dockerfile() 🔗

Dockerfile path

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 dockerfile

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Dockerfile(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.dockerfile()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.dockerfile()
}

dockerNamespace() 🔗

Docker namespace

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 docker-namespace

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			DockerNamespace(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.docker_namespace()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.dockerNamespace()
}

dockerImage() 🔗

Docker image

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 docker-image

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			DockerImage(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.docker_image()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.dockerImage()
}

project() 🔗

Project name

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 project

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			Project(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.project()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.project()
}

kubectlFile() 🔗

Kubectl file path

Return Type

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 kubectl-file

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			GhDeployment().
			KubectlFile(ctx)
}

@function
async def example() -> str:
	return await (
		dag.gh_deployment()
		.kubectl_file()
	)

@func()
async example(): Promise<string> {
	return dag
		.ghDeployment()
		.kubectlFile()
}

createGithubDeployment() 🔗

CreateGitHubDeployment creates a GitHub deployment

Return Type

String !

Arguments

Name	Type	Default Value	Description
token	String !	-	Github token for making api requests

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 create-github-deployment --token string

func (m *myModule) example(ctx context.Context, token string) string  {
	return dag.
			GhDeployment().
			CreateGithubDeployment(ctx, token)
}

@function
async def example(token: str) -> str:
	return await (
		dag.gh_deployment()
		.create_github_deployment(token)
	)

@func()
async example(token: string): Promise<string> {
	return dag
		.ghDeployment()
		.createGithubDeployment(token)
}

withRepository() 🔗

WithRepository sets the GitHub repository name

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
repository	String !	-	GitHub repository name with owner, for example, "tora/bora", Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-repository --repository string

func (m *myModule) example(repository string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithRepository(repository)
}

@function
def example(repository: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_repository(repository)
	)

@func()
example(repository: string): GhDeployment {
	return dag
		.ghDeployment()
		.withRepository(repository)
}

withRef() 🔗

WithRef sets the Git reference (branch, tag, or SHA)

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
ref	String !	-	Git reference, for example, "refs/heads/main", Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-ref --ref string

func (m *myModule) example(ref string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithRef(ref)
}

@function
def example(ref: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_ref(ref)
	)

@func()
example(ref: string): GhDeployment {
	return dag
		.ghDeployment()
		.withRef(ref)
}

withImageTag() 🔗

WithImageTag sets the docker image tag

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
imageTag	String !	-	Image tag, optional

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-image-tag --image-tag string

func (m *myModule) example(imageTag string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithImageTag(imageTag)
}

@function
def example(image_tag: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_image_tag(image_tag)
	)

@func()
example(imageTag: string): GhDeployment {
	return dag
		.ghDeployment()
		.withImageTag(imageTag)
}

withApplication() 🔗

WithApplication sets the application

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
application	String !	-	Application, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-application --application string

func (m *myModule) example(application string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithApplication(application)
}

@function
def example(application: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_application(application)
	)

@func()
example(application: string): GhDeployment {
	return dag
		.ghDeployment()
		.withApplication(application)
}

withStack() 🔗

WithStack sets the stack

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
stack	String !	-	Stack, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-stack --stack string

func (m *myModule) example(stack string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithStack(stack)
}

@function
def example(stack: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_stack(stack)
	)

@func()
example(stack: string): GhDeployment {
	return dag
		.ghDeployment()
		.withStack(stack)
}

withEnvironment() 🔗

WithEnvironment sets the environment with a default value of “development”

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
environment	String !	-	Environment, Optional

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-environment --environment string

func (m *myModule) example(environment string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithEnvironment(environment)
}

@function
def example(environment: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_environment(environment)
	)

@func()
example(environment: string): GhDeployment {
	return dag
		.ghDeployment()
		.withEnvironment(environment)
}

withDockerfile() 🔗

WithDockerfile sets the Dockerfile path

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
dockerfile	String !	-	Dockerfile path, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-dockerfile --dockerfile string

func (m *myModule) example(dockerfile string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithDockerfile(dockerfile)
}

@function
def example(dockerfile: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_dockerfile(dockerfile)
	)

@func()
example(dockerfile: string): GhDeployment {
	return dag
		.ghDeployment()
		.withDockerfile(dockerfile)
}

withDockerNamespace() 🔗

WithDockerNamespace sets the Docker namespace

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
dockerNamespace	String !	-	Docker namespace, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-docker-namespace --docker-namespace string

func (m *myModule) example(dockerNamespace string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithDockerNamespace(dockerNamespace)
}

@function
def example(docker_namespace: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_docker_namespace(docker_namespace)
	)

@func()
example(dockerNamespace: string): GhDeployment {
	return dag
		.ghDeployment()
		.withDockerNamespace(dockerNamespace)
}

withDockerImage() 🔗

WithDockerImage sets the Docker image

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
dockerImage	String !	-	Docker image, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-docker-image --docker-image string

func (m *myModule) example(dockerImage string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithDockerImage(dockerImage)
}

@function
def example(docker_image: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_docker_image(docker_image)
	)

@func()
example(dockerImage: string): GhDeployment {
	return dag
		.ghDeployment()
		.withDockerImage(dockerImage)
}

withProject() 🔗

WithProject sets the project name

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
project	String !	-	Project name, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-project --project string

func (m *myModule) example(project string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithProject(project)
}

@function
def example(project: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_project(project)
	)

@func()
example(project: string): GhDeployment {
	return dag
		.ghDeployment()
		.withProject(project)
}

withKubectlFile() 🔗

WithKubectlFile sets the kubectl file path

Return Type

GhDeployment !

Arguments

Name	Type	Default Value	Description
kubectlFile	String !	-	Kubectl file path, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 with-kubectl-file --kubectl-file string

func (m *myModule) example(kubectlFile string) *GhDeployment  {
	return dag.
			GhDeployment().
			WithKubectlFile(kubectlFile)
}

@function
def example(kubectl_file: str) -> dag.GhDeployment:
	return (
		dag.gh_deployment()
		.with_kubectl_file(kubectl_file)
	)

@func()
example(kubectlFile: string): GhDeployment {
	return dag
		.ghDeployment()
		.withKubectlFile(kubectlFile)
}

generateImageTag() 🔗

Return Type

Void !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 generate-image-tag

func (m *myModule) example(ctx context.Context)   {
	return dag.
			GhDeployment().
			GenerateImageTag(ctx)
}

@function
async def example() -> None:
	return await (
		dag.gh_deployment()
		.generate_image_tag()
	)

@func()
async example(): Promise<void> {
	return dag
		.ghDeployment()
		.generateImageTag()
}

setDeploymentStatus() 🔗

SetDeploymentStatus sets the deployment status using the GitHub API

Return Type

Void !

Arguments

Name	Type	Default Value	Description
deploymentId	String !	-	Deployment ID, Required
status	String !	-	Status, Required
token	String !	-	Github token for making api requests, Required

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gh-deployment@859d4e8ba05cf14cb1c20d944dad1f5fa9770f24 call \
 set-deployment-status --deployment-id string --status string --token string

func (m *myModule) example(ctx context.Context, deploymentId string, status string, token string)   {
	return dag.
			GhDeployment().
			SetDeploymentStatus(ctx, deploymentId, status, token)
}

@function
async def example(deployment_id: str, status: str, token: str) -> None:
	return await (
		dag.gh_deployment()
		.set_deployment_status(deployment_id, status, token)
	)

@func()
async example(deploymentId: string, status: string, token: string): Promise<void> {
	return dag
		.ghDeployment()
		.setDeploymentStatus(deploymentId, status, token)
}