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@3083abedd82d9a6952ef038441ee0768ed68ea0a

Entrypoint

Return Type

WaitGithubDaggerChecks !

Example

dagger -m github.com/typesafe-ai/daggerverse/wait-github-dagger-checks@3083abedd82d9a6952ef038441ee0768ed68ea0a 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 expected check has a successful GitHub commit status on ref.

When checks is None, the expected set is enumerated via dag.current_workspace().checks(). When checks is provided, those names are used verbatim and auto-discovery is skipped. An empty checks list returns immediately.

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
checks	[String ! ]	null	An optional explicit list of check names to wait for.
pollInterval	Integer !	3	Seconds between GitHub polls
progressInterval	Integer !	30	Seconds between routine progress lines (terminal transitions are still printed live).
timeout	Integer !	1800	Total wall-clock budget, seconds
discoveryTimeout	Integer !	300	How long expected statuses may take to first appear, seconds
failFast	Boolean !	false	If True, raise as soon as any check fails. If False (default), wait for every check to reach a terminal state and then raise at the end if any failed.

Example

dagger -m github.com/typesafe-ai/daggerverse/wait-github-dagger-checks@3083abedd82d9a6952ef038441ee0768ed68ea0a call \
 wait --repo string --ref string --token env:MYSECRET --poll-interval integer --progress-interval integer --timeout integer --discovery-timeout integer --fail-fast boolean

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

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

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