Dagger
Search

gitter

including setting repository details and performing actions like checkout and inspect.

Installation

dagger install github.com/dictybase-docker/dagger-of-dcr/gitter@19651c1b7f8e6582f53477827d4608fc02f58630

Entrypoint

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

Types

Gitter 🔗

repository() 🔗

Repository name

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

ref() 🔗

Git reference

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

path() 🔗

Repository path

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

withRef() 🔗

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

Return Type 
Gitter !
Arguments
NameTypeDefault ValueDescription
refString !-the branch, tag or sha to checkout, Required.
Example
func (m *myModule) example(ref string) *Gitter  {
	return dag.
			Gitter().
			WithRef(ref)
}
@function
def example(ref: str) -> dag.Gitter:
	return (
		dag.gitter()
		.with_ref(ref)
	)
@func()
example(ref: string): Gitter {
	return dag
		.gitter()
		.withRef(ref)
}

withRepository() 🔗

WithRepository sets the GitHub repository name

Return Type 
Gitter !
Arguments
NameTypeDefault ValueDescription
repositoryString !-github repository name with owner, for example tora/bora, Required
Example
func (m *myModule) example(repository string) *Gitter  {
	return dag.
			Gitter().
			WithRepository(repository)
}
@function
def example(repository: str) -> dag.Gitter:
	return (
		dag.gitter()
		.with_repository(repository)
	)
@func()
example(repository: string): Gitter {
	return dag
		.gitter()
		.withRepository(repository)
}

checkout() 🔗

Checkout clones the repository and checks out the specific ref

Return Type 
Directory !
Example
func (m *myModule) example() *Directory  {
	return dag.
			Gitter().
			Checkout()
}
@function
def example() -> dagger.Directory:
	return (
		dag.gitter()
		.checkout()
	)
@func()
example(): Directory {
	return dag
		.gitter()
		.checkout()
}

commitHash() 🔗

CommitHash retrieves the short commit hash of the HEAD from the specified Git repository.

Return Type 
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Gitter().
			CommitHash(ctx)
}
@function
async def example() -> str:
	return await (
		dag.gitter()
		.commit_hash()
	)
@func()
async example(): Promise<string> {
	return dag
		.gitter()
		.commitHash()
}

inspect() 🔗

Inspect clones the given repository and returns a Terminal instance for inspection

Return Type 
Terminal !
Example
func (m *myModule) example() *Terminal  {
	return dag.
			Gitter().
			Inspect()
}
@function
def example() -> dag.Terminal:
	return (
		dag.gitter()
		.inspect()
	)
@func()
example(): Terminal {
	return dag
		.gitter()
		.inspect()
}

parseRef() 🔗

ParseRef extracts the branch name from a Git reference string or returns the original reference if no match is found.

Return Type 
String !
Example
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Gitter().
			ParseRef(ctx)
}
@function
async def example() -> str:
	return await (
		dag.gitter()
		.parse_ref()
	)
@func()
async example(): Promise<string> {
	return dag
		.gitter()
		.parseRef()
}