gha

No long description provided.

Installation

dagger install github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7

Entrypoint

Return Type

Gha

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \

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

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

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

Types

Gha 🔗

withPipeline() 🔗

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@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string

func (m *myModule) example(name string) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name)
}

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

@func()
example(name: string): GhaPipeline {
	return dag
		.gha()
		.withPipeline(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 []*GhaPipeline) *File  {
	return dag.
			Gha().
			Pipelines(pipelines)
}

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

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

Pipeline 🔗

runner() 🔗

Return Type

String !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 runner

func (m *myModule) example(ctx context.Context, name string) string  {
	return dag.
			Gha().
			WithPipeline(name).
			Runner(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.gha()
		.with_pipeline(name)
		.runner()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.gha()
		.withPipeline(name)
		.runner()
}

changes() 🔗

Return Type

[String ! ] !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 changes

func (m *myModule) example(ctx context.Context, name string) []string  {
	return dag.
			Gha().
			WithPipeline(name).
			Changes(ctx)
}

@function
async def example(name: str) -> List[str]:
	return await (
		dag.gha()
		.with_pipeline(name)
		.changes()
	)

@func()
async example(name: string): Promise<string[]> {
	return dag
		.gha()
		.withPipeline(name)
		.changes()
}

module() 🔗

Return Type

String !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 module

func (m *myModule) example(ctx context.Context, name string) string  {
	return dag.
			Gha().
			WithPipeline(name).
			Module(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.gha()
		.with_pipeline(name)
		.module()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.gha()
		.withPipeline(name)
		.module()
}

name() 🔗

Return Type

String !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 name

func (m *myModule) example(ctx context.Context, name string) string  {
	return dag.
			Gha().
			WithPipeline(name).
			Name(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.gha()
		.with_pipeline(name)
		.name()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.gha()
		.withPipeline(name)
		.name()
}

prActions() 🔗

Return Type

[Enum ! ] !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 pr-actions

func (m *myModule) example(name string) []  {
	return dag.
			Gha().
			WithPipeline(name).
			PrActions()
}

@function
def example(name: str) -> List[]:
	return (
		dag.gha()
		.with_pipeline(name)
		.pr_actions()
	)

@func()
example(name: string): [] {
	return dag
		.gha()
		.withPipeline(name)
		.prActions()
}

onPr() 🔗

Return Type

Boolean !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 on-pr

func (m *myModule) example(ctx context.Context, name string) bool  {
	return dag.
			Gha().
			WithPipeline(name).
			OnPr(ctx)
}

@function
async def example(name: str) -> bool:
	return await (
		dag.gha()
		.with_pipeline(name)
		.on_pr()
	)

@func()
async example(name: string): Promise<boolean> {
	return dag
		.gha()
		.withPipeline(name)
		.onPr()
}

onPush() 🔗

Return Type

Boolean !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 on-push

func (m *myModule) example(ctx context.Context, name string) bool  {
	return dag.
			Gha().
			WithPipeline(name).
			OnPush(ctx)
}

@function
async def example(name: str) -> bool:
	return await (
		dag.gha()
		.with_pipeline(name)
		.on_push()
	)

@func()
async example(name: string): Promise<boolean> {
	return dag
		.gha()
		.withPipeline(name)
		.onPush()
}

branches() 🔗

Return Type

[String ! ] !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 branches

func (m *myModule) example(ctx context.Context, name string) []string  {
	return dag.
			Gha().
			WithPipeline(name).
			Branches(ctx)
}

@function
async def example(name: str) -> List[str]:
	return await (
		dag.gha()
		.with_pipeline(name)
		.branches()
	)

@func()
async example(name: string): Promise<string[]> {
	return dag
		.gha()
		.withPipeline(name)
		.branches()
}

exec() 🔗

Return Type

String !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 exec

func (m *myModule) example(ctx context.Context, name string) string  {
	return dag.
			Gha().
			WithPipeline(name).
			Exec(ctx)
}

@function
async def example(name: str) -> str:
	return await (
		dag.gha()
		.with_pipeline(name)
		.exec()
	)

@func()
async example(name: string): Promise<string> {
	return dag
		.gha()
		.withPipeline(name)
		.exec()
}

after() 🔗

Return Type

[String ! ] !

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 after

func (m *myModule) example(ctx context.Context, name string) []string  {
	return dag.
			Gha().
			WithPipeline(name).
			After(ctx)
}

@function
async def example(name: str) -> List[str]:
	return await (
		dag.gha()
		.with_pipeline(name)
		.after()
	)

@func()
async example(name: string): Promise<string[]> {
	return dag
		.gha()
		.withPipeline(name)
		.after()
}

withRunsOn() 🔗

Return Type

Pipeline !

Arguments

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

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 with-runs-on --name string

func (m *myModule) example(name string, name1 string) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name).
			WithRunsOn(name1)
}

@function
def example(name: str, name1: str) -> dag.GhaPipeline:
	return (
		dag.gha()
		.with_pipeline(name)
		.with_runs_on(name1)
	)

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

withOnPullRequest() 🔗

Return Type

Pipeline !

Arguments

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

Example

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

func (m *myModule) example(name string, actions []) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name).
			WithOnPullRequest(actions)
}

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

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

withOnChanges() 🔗

Return Type

Pipeline !

Arguments

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

Example

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

func (m *myModule) example(name string, paths []string) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name).
			WithOnChanges(paths)
}

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

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

withOnPush() 🔗

Return Type

Pipeline !

Arguments

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

Example

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

func (m *myModule) example(name string, branches []string) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name).
			WithOnPush(branches)
}

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

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

withModule() 🔗

Return Type

Pipeline !

Arguments

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

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 with-module --path string

func (m *myModule) example(name string, path string) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name).
			WithModule(path)
}

@function
def example(name: str, path: str) -> dag.GhaPipeline:
	return (
		dag.gha()
		.with_pipeline(name)
		.with_module(path)
	)

@func()
example(name: string, path: string): GhaPipeline {
	return dag
		.gha()
		.withPipeline(name)
		.withModule(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@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 call --exec string

func (m *myModule) example(name string, exec string) *GhaPipeline  {
	return dag.
			Gha().
			WithPipeline(name).
			Call(exec)
}

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

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

after() 🔗

Return Type

Pipeline !

Arguments

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

Example

dagger -m github.com/franela/pocketci/modules/gha@1cae77909b2ad0ace74301545a39d50d8af431b7 call \
 with-pipeline --name string \
 after

func (m *myModule) example(ctx context.Context, name string) []string  {
	return dag.
			Gha().
			WithPipeline(name).
			After(ctx)
}

@function
async def example(name: str) -> List[str]:
	return await (
		dag.gha()
		.with_pipeline(name)
		.after()
	)

@func()
async example(name: string): Promise<string[]> {
	return dag
		.gha()
		.withPipeline(name)
		.after()
}