gha

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/franela/pocketci/modules/gha@d7e7c7594688ed51929c7623149b92c5593d3957

Entrypoint

Return Type

Gha !

Arguments

Name	Type	Description
eventSrc	File !	No description provided

Example

dagger -m github.com/franela/pocketci/modules/gha@d7e7c7594688ed51929c7623149b92c5593d3957 call \
 --event-src file:path

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

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

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

Types

Gha 🔗

githubEvent() 🔗

Return Type

GithubEvent !

Example

dagger -m github.com/franela/pocketci/modules/gha@d7e7c7594688ed51929c7623149b92c5593d3957 call \
 --event-src file:path github-event

func (m *myModule) example(eventSrc *File) *GhaGithubEvent  {
	return dag.
			Gha(eventSrc).
			GithubEvent()
}

@function
def example(event_src: dagger.File) -> dag.GhaGithubEvent:
	return (
		dag.gha(event_src)
		.github_event()
	)

@func()
example(eventSrc: File): GhaGithubEvent {
	return dag
		.gha(eventSrc)
		.githubEvent()
}

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@d7e7c7594688ed51929c7623149b92c5593d3957 call \
 --event-src file:path with-pipeline --name string

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

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

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

Pipeline 🔗

runsOn() 🔗

Return Type

String !

Example

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

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

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

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

changes() 🔗

Return Type

[String ! ] !

Example

dagger -m github.com/franela/pocketci/modules/gha@d7e7c7594688ed51929c7623149b92c5593d3957 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@d7e7c7594688ed51929c7623149b92c5593d3957 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@d7e7c7594688ed51929c7623149b92c5593d3957 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()
}

event() 🔗

Return Type

GithubEvent !

Example

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

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

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

@func()
example(name: string): GhaGithubEvent {
	return dag
		.gha()
		.withPipeline(name)
		.event()
}

actions() 🔗

Return Type

[Enum ! ] !

Example

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

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

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

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

onPullRequest() 🔗

Return Type

Boolean !

Example

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

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

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

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

withRunsOn() 🔗

Return Type

Pipeline !

Arguments

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

Example

dagger -m github.com/franela/pocketci/modules/gha@d7e7c7594688ed51929c7623149b92c5593d3957 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@d7e7c7594688ed51929c7623149b92c5593d3957 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@d7e7c7594688ed51929c7623149b92c5593d3957 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)
}

withModule() 🔗

Return Type

Pipeline !

Arguments

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

Example

dagger -m github.com/franela/pocketci/modules/gha@d7e7c7594688ed51929c7623149b92c5593d3957 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

Void !

Arguments

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

Example

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

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

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

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

GithubEvent 🔗

eventType() 🔗

Return Type

String !

Example

Function GhaGithubEvent.eventType is not accessible from the gha module

Function GhaGithubEvent.eventType is not accessible from the gha module

Function GhaGithubEvent.eventType is not accessible from the gha module

Function GhaGithubEvent.eventType is not accessible from the gha module

filesChanged() 🔗

Return Type

[String ! ] !

Example

Function GhaGithubEvent.filesChanged is not accessible from the gha module

Function GhaGithubEvent.filesChanged is not accessible from the gha module

Function GhaGithubEvent.filesChanged is not accessible from the gha module

Function GhaGithubEvent.filesChanged is not accessible from the gha module

repositoryName() 🔗

Return Type

String !

Example

Function GhaGithubEvent.repositoryName is not accessible from the gha module

Function GhaGithubEvent.repositoryName is not accessible from the gha module

Function GhaGithubEvent.repositoryName is not accessible from the gha module

Function GhaGithubEvent.repositoryName is not accessible from the gha module

ref() 🔗

Return Type

String !

Example

Function GhaGithubEvent.ref is not accessible from the gha module

Function GhaGithubEvent.ref is not accessible from the gha module

Function GhaGithubEvent.ref is not accessible from the gha module

Function GhaGithubEvent.ref is not accessible from the gha module

sha() 🔗

Return Type

String !

Example

Function GhaGithubEvent.sha is not accessible from the gha module

Function GhaGithubEvent.sha is not accessible from the gha module

Function GhaGithubEvent.sha is not accessible from the gha module

Function GhaGithubEvent.sha is not accessible from the gha module

baseRef() 🔗

Return Type

String !

Example

Function GhaGithubEvent.baseRef is not accessible from the gha module

Function GhaGithubEvent.baseRef is not accessible from the gha module

Function GhaGithubEvent.baseRef is not accessible from the gha module

Function GhaGithubEvent.baseRef is not accessible from the gha module

baseSha() 🔗

Return Type

String !

Example

Function GhaGithubEvent.baseSha is not accessible from the gha module

Function GhaGithubEvent.baseSha is not accessible from the gha module

Function GhaGithubEvent.baseSha is not accessible from the gha module

Function GhaGithubEvent.baseSha is not accessible from the gha module

prNumber() 🔗

Return Type

Integer !

Example

Function GhaGithubEvent.prNumber is not accessible from the gha module

Function GhaGithubEvent.prNumber is not accessible from the gha module

Function GhaGithubEvent.prNumber is not accessible from the gha module

Function GhaGithubEvent.prNumber is not accessible from the gha module

pullRequest() 🔗

Return Type

PullRequest !

Example

Function GhaGithubEvent.pullRequest is not accessible from the gha module

Function GhaGithubEvent.pullRequest is not accessible from the gha module

Function GhaGithubEvent.pullRequest is not accessible from the gha module

Function GhaGithubEvent.pullRequest is not accessible from the gha module

PullRequest 🔗

action() 🔗

Action is the action that was performed. Possible values are: “assigned”, “unassigned”, “review_requested”, “review_request_removed”, “labeled”, “unlabeled”, “opened”, “edited”, “closed”, “ready_for_review”, “locked”, “unlocked”, or “reopened”. If the action is “closed” and the “merged” key is “false”, the pull request was closed with unmerged commits. If the action is “closed” and the “merged” key is “true”, the pull request was merged. While webhooks are also triggered when a pull request is synchronized, Events API timelines don’t include pull request events with the “synchronize” action.

Return Type

String !

Example

Function GhaPullRequest.action is not accessible from the gha module

Function GhaPullRequest.action is not accessible from the gha module

Function GhaPullRequest.action is not accessible from the gha module

Function GhaPullRequest.action is not accessible from the gha module

number() 🔗

Return Type

Integer !

Example

Function GhaPullRequest.number is not accessible from the gha module

Function GhaPullRequest.number is not accessible from the gha module

Function GhaPullRequest.number is not accessible from the gha module

Function GhaPullRequest.number is not accessible from the gha module

pullRequest() 🔗

Return Type

PullRequestSpec !

Example

Function GhaPullRequest.pullRequest is not accessible from the gha module

Function GhaPullRequest.pullRequest is not accessible from the gha module

Function GhaPullRequest.pullRequest is not accessible from the gha module

Function GhaPullRequest.pullRequest is not accessible from the gha module

repo() 🔗

Return Type

Repository !

Example

Function GhaPullRequest.repo is not accessible from the gha module

Function GhaPullRequest.repo is not accessible from the gha module

Function GhaPullRequest.repo is not accessible from the gha module

Function GhaPullRequest.repo is not accessible from the gha module

label() 🔗

Return Type

String !

Example

Function GhaPullRequest.label is not accessible from the gha module

Function GhaPullRequest.label is not accessible from the gha module

Function GhaPullRequest.label is not accessible from the gha module

Function GhaPullRequest.label is not accessible from the gha module

PullRequestSpec 🔗

number() 🔗

Return Type

Integer !

Example

Function GhaPullRequestSpec.number is not accessible from the gha module

Function GhaPullRequestSpec.number is not accessible from the gha module

Function GhaPullRequestSpec.number is not accessible from the gha module

Function GhaPullRequestSpec.number is not accessible from the gha module

state() 🔗

Return Type

String !

Example

Function GhaPullRequestSpec.state is not accessible from the gha module

Function GhaPullRequestSpec.state is not accessible from the gha module

Function GhaPullRequestSpec.state is not accessible from the gha module

Function GhaPullRequestSpec.state is not accessible from the gha module

locked() 🔗

Return Type

Boolean !

Example

Function GhaPullRequestSpec.locked is not accessible from the gha module

Function GhaPullRequestSpec.locked is not accessible from the gha module

Function GhaPullRequestSpec.locked is not accessible from the gha module

Function GhaPullRequestSpec.locked is not accessible from the gha module

createdAt() 🔗

Return Type

String !

Example

Function GhaPullRequestSpec.createdAt is not accessible from the gha module

Function GhaPullRequestSpec.createdAt is not accessible from the gha module

Function GhaPullRequestSpec.createdAt is not accessible from the gha module

Function GhaPullRequestSpec.createdAt is not accessible from the gha module

updatedAt() 🔗

Return Type

String !

Example

Function GhaPullRequestSpec.updatedAt is not accessible from the gha module

Function GhaPullRequestSpec.updatedAt is not accessible from the gha module

Function GhaPullRequestSpec.updatedAt is not accessible from the gha module

Function GhaPullRequestSpec.updatedAt is not accessible from the gha module

closedAt() 🔗

Return Type

String !

Example

Function GhaPullRequestSpec.closedAt is not accessible from the gha module

Function GhaPullRequestSpec.closedAt is not accessible from the gha module

Function GhaPullRequestSpec.closedAt is not accessible from the gha module

Function GhaPullRequestSpec.closedAt is not accessible from the gha module

mergedAt() 🔗

Return Type

String !

Example

Function GhaPullRequestSpec.mergedAt is not accessible from the gha module

Function GhaPullRequestSpec.mergedAt is not accessible from the gha module

Function GhaPullRequestSpec.mergedAt is not accessible from the gha module

Function GhaPullRequestSpec.mergedAt is not accessible from the gha module

labels() 🔗

Return Type

[String ! ] !

Example

Function GhaPullRequestSpec.labels is not accessible from the gha module

Function GhaPullRequestSpec.labels is not accessible from the gha module

Function GhaPullRequestSpec.labels is not accessible from the gha module

Function GhaPullRequestSpec.labels is not accessible from the gha module

merged() 🔗

Return Type

Boolean !

Example

Function GhaPullRequestSpec.merged is not accessible from the gha module

Function GhaPullRequestSpec.merged is not accessible from the gha module

Function GhaPullRequestSpec.merged is not accessible from the gha module

Function GhaPullRequestSpec.merged is not accessible from the gha module

mergeable() 🔗

Return Type

Boolean !

Example

Function GhaPullRequestSpec.mergeable is not accessible from the gha module

Function GhaPullRequestSpec.mergeable is not accessible from the gha module

Function GhaPullRequestSpec.mergeable is not accessible from the gha module

Function GhaPullRequestSpec.mergeable is not accessible from the gha module

mergeableState() 🔗

Return Type

String !

Example

Function GhaPullRequestSpec.mergeableState is not accessible from the gha module

Function GhaPullRequestSpec.mergeableState is not accessible from the gha module

Function GhaPullRequestSpec.mergeableState is not accessible from the gha module

Function GhaPullRequestSpec.mergeableState is not accessible from the gha module

head() 🔗

Return Type

PullRequestBranch !

Example

Function GhaPullRequestSpec.head is not accessible from the gha module

Function GhaPullRequestSpec.head is not accessible from the gha module

Function GhaPullRequestSpec.head is not accessible from the gha module

Function GhaPullRequestSpec.head is not accessible from the gha module

base() 🔗

Return Type

PullRequestBranch !

Example

Function GhaPullRequestSpec.base is not accessible from the gha module

Function GhaPullRequestSpec.base is not accessible from the gha module

Function GhaPullRequestSpec.base is not accessible from the gha module

Function GhaPullRequestSpec.base is not accessible from the gha module

Repository 🔗

owner() 🔗

Return Type

User !

Example

Function GhaRepository.owner is not accessible from the gha module

Function GhaRepository.owner is not accessible from the gha module

Function GhaRepository.owner is not accessible from the gha module

Function GhaRepository.owner is not accessible from the gha module

name() 🔗

Return Type

String !

Example

Function GhaRepository.name is not accessible from the gha module

Function GhaRepository.name is not accessible from the gha module

Function GhaRepository.name is not accessible from the gha module

Function GhaRepository.name is not accessible from the gha module

fullName() 🔗

Return Type

String !

Example

Function GhaRepository.fullName is not accessible from the gha module

Function GhaRepository.fullName is not accessible from the gha module

Function GhaRepository.fullName is not accessible from the gha module

Function GhaRepository.fullName is not accessible from the gha module

PullRequestBranch 🔗

label() 🔗

Return Type

String !

Example

Function GhaPullRequestBranch.label is not accessible from the gha module

Function GhaPullRequestBranch.label is not accessible from the gha module

Function GhaPullRequestBranch.label is not accessible from the gha module

Function GhaPullRequestBranch.label is not accessible from the gha module

ref() 🔗

Return Type

String !

Example

Function GhaPullRequestBranch.ref is not accessible from the gha module

Function GhaPullRequestBranch.ref is not accessible from the gha module

Function GhaPullRequestBranch.ref is not accessible from the gha module

Function GhaPullRequestBranch.ref is not accessible from the gha module

sha() 🔗

Return Type

String !

Example

Function GhaPullRequestBranch.sha is not accessible from the gha module

Function GhaPullRequestBranch.sha is not accessible from the gha module

Function GhaPullRequestBranch.sha is not accessible from the gha module

Function GhaPullRequestBranch.sha is not accessible from the gha module

repo() 🔗

Return Type

Repository !

Example

Function GhaPullRequestBranch.repo is not accessible from the gha module

Function GhaPullRequestBranch.repo is not accessible from the gha module

Function GhaPullRequestBranch.repo is not accessible from the gha module

Function GhaPullRequestBranch.repo is not accessible from the gha module

User 🔗

Return Type

String !

Example

Function GhaUser.login is not accessible from the gha module

Function GhaUser.login is not accessible from the gha module

Function GhaUser.login is not accessible from the gha module

Function GhaUser.login is not accessible from the gha module

name() 🔗

Return Type

String !

Example

Function GhaUser.name is not accessible from the gha module

Function GhaUser.name is not accessible from the gha module

Function GhaUser.name is not accessible from the gha module

Function GhaUser.name is not accessible from the gha module

userType() 🔗

Return Type

String !

Example

Function GhaUser.userType is not accessible from the gha module

Function GhaUser.userType is not accessible from the gha module

Function GhaUser.userType is not accessible from the gha module

Function GhaUser.userType is not accessible from the gha module