gha
Installation
Entrypoint
Types
Gha
- pipeline()
- pipelines()
Pipeline

gha

No long description provided.

Installation

dagger install github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a

Entrypoint

Return Type

Gha

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \

func (m *MyModule) Example() *dagger.Gha  {
	return dag.
			Gha()
}

@function
def example() -> dagger.Gha:
	return (
		dag.gha()
	)

@func()
example(): Gha {
	return dag
		.gha()
}

Types

Gha 🔗

pipeline() 🔗

Returns a container that echoes whatever string argument is provided

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string

func (m *MyModule) Example(name string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name)
}

@function
def example(name: str) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
	)

@func()
example(name: string): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
}

pipelines() 🔗

Return Type

File !

Arguments

Name	Type	Default Value	Description
pipelines	[Pipeline ! ] !	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(pipelines []*dagger.GhaPipeline) *dagger.File  {
	return dag.
			Gha().
			Pipelines(pipelines)
}

@function
def example(pipelines: List[dagger.GhaPipeline]) -> dagger.File:
	return (
		dag.gha()
		.pipelines(pipelines)
	)

@func()
example(pipelines: GhaPipeline[]): File {
	return dag
		.gha()
		.pipelines(pipelines)
}

Pipeline 🔗

runsOn() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
name	String !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 runs-on --name string

func (m *MyModule) Example(name string, name1 string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			RunsOn(name1)
}

@function
def example(name: str, name1: str) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.runs_on(name1)
	)

@func()
example(name: string, name1: string): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.runsOn(name1)
}

onPullRequest() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
actions	[Enum ! ] !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 on-pull-request

func (m *MyModule) Example(name string, actions []) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			OnPullRequest(actions)
}

@function
def example(name: str, actions: List[]) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.on_pull_request(actions)
	)

@func()
example(name: string, actions: []): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.onPullRequest(actions)
}

onPullRequestAgainst() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
actions	[Enum ! ] !	-	No description provided
branches	[String ! ] !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 on-pull-request-against --branches string1 --branches string2

func (m *MyModule) Example(name string, actions [], branches []string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			OnPullRequestAgainst(actions, branches)
}

@function
def example(name: str, actions: List[], branches: List[str]) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.on_pull_request_against(actions, branches)
	)

@func()
example(name: string, actions: [], branches: string[]): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.onPullRequestAgainst(actions, branches)
}

onChanges() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
paths	[String ! ] !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 on-changes --paths string1 --paths string2

func (m *MyModule) Example(name string, paths []string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			OnChanges(paths)
}

@function
def example(name: str, paths: List[str]) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.on_changes(paths)
	)

@func()
example(name: string, paths: string[]): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.onChanges(paths)
}

onPush() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
branches	[String ! ] !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 on-push --branches string1 --branches string2

func (m *MyModule) Example(name string, branches []string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			OnPush(branches)
}

@function
def example(name: str, branches: List[str]) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.on_push(branches)
	)

@func()
example(name: string, branches: string[]): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.onPush(branches)
}

module() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
path	String !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 module --path string

func (m *MyModule) Example(name string, path string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			Module(path)
}

@function
def example(name: str, path: str) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.module(path)
	)

@func()
example(name: string, path: string): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.module(path)
}

call() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
exec	String !	-	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@128391da299c7f107283b8872d64a2c28fc9216a call \
 pipeline --name string \
 call --exec string

func (m *MyModule) Example(name string, exec string) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			Call(exec)
}

@function
def example(name: str, exec: str) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.call(exec)
	)

@func()
example(name: string, exec: string): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.call(exec)
}

after() 🔗

Return Type

Pipeline !

Arguments

Name	Type	Default Value	Description
pipelines	[Pipeline ! ] !	-	No description provided

Example

echo 'Custom types are not supported in shell examples'

func (m *MyModule) Example(name string, pipelines []*dagger.GhaPipeline) *dagger.GhaPipeline  {
	return dag.
			Gha().
			Pipeline(name).
			After(pipelines)
}

@function
def example(name: str, pipelines: List[dagger.GhaPipeline]) -> dagger.GhaPipeline:
	return (
		dag.gha()
		.pipeline(name)
		.after(pipelines)
	)

@func()
example(name: string, pipelines: GhaPipeline[]): GhaPipeline {
	return dag
		.gha()
		.pipeline(name)
		.after(pipelines)
}