Dagger
Search

github

No long description provided.

Installation

dagger install github.com/Clarity-Innovation-Technology-Inc/daggerverse/github@v0.1.0

Entrypoint

Return Type
Github !
Arguments
NameTypeDescription
urlString The url for the Github repo to fetch. Only supports git cloning via https!
branchString The branch of the Github repo to fetch.
Example
func (m *myModule) example() *Github  {
	return dag.
			Github()
}
@function
def example() -> dag.Github:
	return (
		dag.github()
	)
@func()
example(): Github {
	return dag
		.github()
}

Types

Github 🔗

url() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Github().
			Url(ctx)
}
@function
async def example() -> str:
	return await (
		dag.github()
		.url()
	)
@func()
async example(): Promise<string> {
	return dag
		.github()
		.url()
}

branch() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Github().
			Branch(ctx)
}
@function
async def example() -> str:
	return await (
		dag.github()
		.branch()
	)
@func()
async example(): Promise<string> {
	return dag
		.github()
		.branch()
}

withUrl() 🔗

Return Type
Github !
Arguments
NameTypeDefault ValueDescription
addrString !-No description provided
Example
func (m *myModule) example(addr string) *Github  {
	return dag.
			Github().
			WithUrl(addr)
}
@function
def example(addr: str) -> dag.Github:
	return (
		dag.github()
		.with_url(addr)
	)
@func()
example(addr: string): Github {
	return dag
		.github()
		.withUrl(addr)
}

withBranch() 🔗

Return Type
Github !
Arguments
NameTypeDefault ValueDescription
branchString !-No description provided
Example
func (m *myModule) example(branch string) *Github  {
	return dag.
			Github().
			WithBranch(branch)
}
@function
def example(branch: str) -> dag.Github:
	return (
		dag.github()
		.with_branch(branch)
	)
@func()
example(branch: string): Github {
	return dag
		.github()
		.withBranch(branch)
}

container() 🔗

very opinionated regarding where repo is stored, if users are allowed to choose path opens potential for malicious input

Return Type
Container !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-No description provided
Example
func (m *myModule) example(token *Secret) *Container  {
	return dag.
			Github().
			Container(token)
}
@function
def example(token: dagger.Secret) -> dagger.Container:
	return (
		dag.github()
		.container(token)
	)
@func()
example(token: Secret): Container {
	return dag
		.github()
		.container(token)
}