wait-github-dagger-checks
Installation
Entrypoint
Types
WaitGithubDaggerChecks
- wait()

wait-github-dagger-checks

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/typesafe-ai/daggerverse/wait-github-dagger-checks@8afd377e69cfa2a8cbb4927f3c0725805dde28c7

Entrypoint

Return Type

WaitGithubDaggerChecks !

Example

dagger -m github.com/typesafe-ai/daggerverse/wait-github-dagger-checks@8afd377e69cfa2a8cbb4927f3c0725805dde28c7 call \

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

@function
def example() -> dagger.WaitGithubDaggerChecks:
	return (
		dag.wait_github_dagger_checks()
	)

@func()
example(): WaitGithubDaggerChecks {
	return dag
		.waitGithubDaggerChecks()
}

Types

WaitGithubDaggerChecks 🔗

wait() 🔗

Wait until every Dagger check in the current workspace has a successful GitHub commit status on ref.

The expected check set is enumerated via dag.current_workspace().checks(), so caller-side check lists or regexes are not needed.

Return Type

String !

Arguments

Name	Type	Default Value	Description
repo	String !	-	GitHub repo as 'owner/name'
ref	String !	-	Commit SHA to poll
token	Secret !	-	GitHub token with read access
pollInterval	Integer !	10	Seconds between polls
timeout	Integer !	1800	Total wall-clock budget, seconds
discoveryTimeout	Integer !	300	How long expected statuses may take to first appear, seconds

Example

dagger -m github.com/typesafe-ai/daggerverse/wait-github-dagger-checks@8afd377e69cfa2a8cbb4927f3c0725805dde28c7 call \
 wait --repo string --ref string --token env:MYSECRET --poll-interval integer --timeout integer --discovery-timeout integer

func (m *MyModule) Example(ctx context.Context, repo string, ref string, token *dagger.Secret, pollInterval int, timeout int, discoveryTimeout int) string  {
	return dag.
			WaitGithubDaggerChecks().
			Wait(ctx, repo, ref, token, pollInterval, timeout, discoveryTimeout)
}

@function
async def example(repo: str, ref: str, token: dagger.Secret, poll_interval: int, timeout: int, discovery_timeout: int) -> str:
	return await (
		dag.wait_github_dagger_checks()
		.wait(repo, ref, token, poll_interval, timeout, discovery_timeout)
	)

@func()
async example(repo: string, ref: string, token: Secret, pollInterval: number, timeout: number, discoveryTimeout: number): Promise<string> {
	return dag
		.waitGithubDaggerChecks()
		.wait(repo, ref, token, pollInterval, timeout, discoveryTimeout)
}