gitter

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

Installation

dagger install github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7

Gitter

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \

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

@function
def example() -> dag.Gitter:
	return (
		dag.gitter()
	)

@func()
example(): Gitter {
	return dag
		.gitter()
}

Repository name

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 repository

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()
}

Git reference

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 ref

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()
}

Repository path

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 path

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 sets the Git reference (branch, tag, or SHA)

Gitter !

Name	Type	Default Value	Description
ref	String !	-	the branch, tag or sha to checkout, Required.

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 with-ref --ref string

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 sets the GitHub repository name

Gitter !

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/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 with-repository --repository string

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 clones the repository and checks out the specific ref

Directory !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 checkout

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 retrieves the short commit hash of the HEAD from the specified Git repository.

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 commit-hash

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 clones the given repository and returns a Terminal instance for inspection

Terminal !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 inspect

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 extracts the branch name from a Git reference string or returns the original reference if no match is found.

String !

Example

dagger -m github.com/dictybase-docker/dagger-of-dcr/gitter@471213af9f4e833abfd692a883790f14fbfc3fb7 call \
 parse-ref

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()
}