Dagger
Search

gale

No long description provided.

Installation

dagger install github.com/aweris/gale/daggerverse/gale@051b8aec2704cd8a4e2a6633be658f8d4e16a893

Entrypoint

Return Type
Gale
Example
dagger -m github.com/aweris/gale/daggerverse/gale@051b8aec2704cd8a4e2a6633be658f8d4e16a893 call \
func (m *myModule) example() *Gale  {
	return dag.
			Gale()
}
@function
def example() -> dag.Gale:
	return (
		dag.gale()
	)
@func()
example(): Gale {
	return dag
		.gale()
}

Types

WorkflowRun 🔗

runner() 🔗

Base container to use for the workflow run.

Return Type
RunnerContainer !
Example
Function GaleWorkflowRun.Runner is not accessible from the gale module
Function GaleWorkflowRun.Runner is not accessible from the gale module
Function GaleWorkflowRun.Runner is not accessible from the gale module
Function GaleWorkflowRun.Runner is not accessible from the gale module

runCachePath() 🔗

Workflow run cache path to mount to runner containers.

Return Type
StringKind !
Example
Function GaleWorkflowRun.RunCachePath is not accessible from the gale module
Function GaleWorkflowRun.RunCachePath is not accessible from the gale module
Function GaleWorkflowRun.RunCachePath is not accessible from the gale module
Function GaleWorkflowRun.RunCachePath is not accessible from the gale module

runCacheVolume() 🔗

Workflow run cache volume to share data between jobs in the same workflow run and keep the data after the workflow

Return Type
CacheVolume !
Example
Function GaleWorkflowRun.RunCacheVolume is not accessible from the gale module
Function GaleWorkflowRun.RunCacheVolume is not accessible from the gale module
Function GaleWorkflowRun.RunCacheVolume is not accessible from the gale module
Function GaleWorkflowRun.RunCacheVolume is not accessible from the gale module

config() 🔗

Configuration of the workflow run.

Return Type
WorkflowRunConfig !
Example
Function GaleWorkflowRun.Config is not accessible from the gale module
Function GaleWorkflowRun.Config is not accessible from the gale module
Function GaleWorkflowRun.Config is not accessible from the gale module
Function GaleWorkflowRun.Config is not accessible from the gale module

sync() 🔗

Sync runs the workflow and returns the container that ran the workflow.

Return Type
Container !
Example
Function GaleWorkflowRun.sync is not accessible from the gale module
Function GaleWorkflowRun.sync is not accessible from the gale module
Function GaleWorkflowRun.sync is not accessible from the gale module
Function GaleWorkflowRun.sync is not accessible from the gale module

directory() 🔗

Directory returns the directory of the workflow run information.

Return Type
Directory !
Arguments
NameTypeDefault ValueDescription
includeRepoBooleanKind -No description provided
includeSecretsBooleanKind -No description provided
includeEventBooleanKind -No description provided
includeArtifactsBooleanKind -No description provided
Example
Function GaleWorkflowRun.directory is not accessible from the gale module
Function GaleWorkflowRun.directory is not accessible from the gale module
Function GaleWorkflowRun.directory is not accessible from the gale module
Function GaleWorkflowRun.directory is not accessible from the gale module

Gale 🔗

runner() 🔗

Runner represents a runner to run a Github Actions workflow in.

Return Type
Runner !
Example
dagger -m github.com/aweris/gale/daggerverse/gale@051b8aec2704cd8a4e2a6633be658f8d4e16a893 call \
 runner
func (m *myModule) example()   {
	return dag.
			Gale().
			Runner()
}
@function
def example() -> :
	return (
		dag.gale()
		.runner()
	)
@func()
example():  {
	return dag
		.gale()
		.runner()
}

list() 🔗

List returns a list of workflows and their jobs with the given options.

Return Type
StringKind !
Arguments
NameTypeDefault ValueDescription
sourceDirectory -No description provided
repoStringKind -No description provided
tagStringKind -No description provided
branchStringKind -No description provided
workflowsDirStringKind -No description provided
Example
dagger -m github.com/aweris/gale/daggerverse/gale@051b8aec2704cd8a4e2a6633be658f8d4e16a893 call \
 list
func (m *myModule) example()   {
	return dag.
			Gale().
			List()
}
@function
def example() -> :
	return (
		dag.gale()
		.list()
	)
@func()
example():  {
	return dag
		.gale()
		.list()
}

run() 🔗

Run runs the workflow with the given options.

Return Type
WorkflowRun !
Arguments
NameTypeDefault ValueDescription
sourceDirectory -No description provided
repoStringKind -No description provided
tagStringKind -No description provided
branchStringKind -No description provided
workflowsDirStringKind -No description provided
workflowFileFile -No description provided
workflowStringKind -No description provided
jobStringKind -No description provided
eventStringKind -No description provided
eventFileFile -No description provided
containerContainer -No description provided
runnerDebugBooleanKind -No description provided
tokenSecret -No description provided
Example
dagger -m github.com/aweris/gale/daggerverse/gale@051b8aec2704cd8a4e2a6633be658f8d4e16a893 call \
 run
func (m *myModule) example()   {
	return dag.
			Gale().
			Run()
}
@function
def example() -> :
	return (
		dag.gale()
		.run()
	)
@func()
example():  {
	return dag
		.gale()
		.run()
}

Runner 🔗

container() 🔗

Container initializes a new runner container with the given options.

Return Type
RunnerContainer !
Arguments
NameTypeDefault ValueDescription
containerContainer -No description provided
sourceDirectory -No description provided
repoStringKind -No description provided
tagStringKind -No description provided
branchStringKind -No description provided
Example
Function GaleRunner.container is not accessible from the gale module
Function GaleRunner.container is not accessible from the gale module
Function GaleRunner.container is not accessible from the gale module
Function GaleRunner.container is not accessible from the gale module

RunnerContainer 🔗

runnerId() 🔗

Unique identifier for the runner container.

Return Type
StringKind !
Example
Function GaleRunnerContainer.RunnerID is not accessible from the gale module
Function GaleRunnerContainer.RunnerID is not accessible from the gale module
Function GaleRunnerContainer.RunnerID is not accessible from the gale module
Function GaleRunnerContainer.RunnerID is not accessible from the gale module

ctr() 🔗

Initialized container to run the workflow in.

Return Type
Container !
Example
Function GaleRunnerContainer.Ctr is not accessible from the gale module
Function GaleRunnerContainer.Ctr is not accessible from the gale module
Function GaleRunnerContainer.Ctr is not accessible from the gale module
Function GaleRunnerContainer.Ctr is not accessible from the gale module

container() 🔗

Container initializes a new runner container with the given options.

Return Type
Container !
Example
Function GaleRunnerContainer.container is not accessible from the gale module
Function GaleRunnerContainer.container is not accessible from the gale module
Function GaleRunnerContainer.container is not accessible from the gale module
Function GaleRunnerContainer.container is not accessible from the gale module

WorkflowRunConfig 🔗

workflowFile() 🔗

WorkflowFile is external workflow file to run.

Return Type
File !
Example
Function GaleWorkflowRunConfig.WorkflowFile is not accessible from the gale module
Function GaleWorkflowRunConfig.WorkflowFile is not accessible from the gale module
Function GaleWorkflowRunConfig.WorkflowFile is not accessible from the gale module
Function GaleWorkflowRunConfig.WorkflowFile is not accessible from the gale module

workflow() 🔗

Workflow to run.

Return Type
StringKind !
Example
Function GaleWorkflowRunConfig.Workflow is not accessible from the gale module
Function GaleWorkflowRunConfig.Workflow is not accessible from the gale module
Function GaleWorkflowRunConfig.Workflow is not accessible from the gale module
Function GaleWorkflowRunConfig.Workflow is not accessible from the gale module

job() 🔗

Job name to run. If empty, all jobs will be run.

Return Type
StringKind !
Example
Function GaleWorkflowRunConfig.Job is not accessible from the gale module
Function GaleWorkflowRunConfig.Job is not accessible from the gale module
Function GaleWorkflowRunConfig.Job is not accessible from the gale module
Function GaleWorkflowRunConfig.Job is not accessible from the gale module

event() 🔗

Name of the event that triggered the workflow. e.g. push

Return Type
StringKind !
Example
Function GaleWorkflowRunConfig.Event is not accessible from the gale module
Function GaleWorkflowRunConfig.Event is not accessible from the gale module
Function GaleWorkflowRunConfig.Event is not accessible from the gale module
Function GaleWorkflowRunConfig.Event is not accessible from the gale module

eventFile() 🔗

File with the complete webhook event payload.

Return Type
File !
Example
Function GaleWorkflowRunConfig.EventFile is not accessible from the gale module
Function GaleWorkflowRunConfig.EventFile is not accessible from the gale module
Function GaleWorkflowRunConfig.EventFile is not accessible from the gale module
Function GaleWorkflowRunConfig.EventFile is not accessible from the gale module

runnerDebug() 🔗

Enables debug mode.

Return Type
BooleanKind !
Example
Function GaleWorkflowRunConfig.RunnerDebug is not accessible from the gale module
Function GaleWorkflowRunConfig.RunnerDebug is not accessible from the gale module
Function GaleWorkflowRunConfig.RunnerDebug is not accessible from the gale module
Function GaleWorkflowRunConfig.RunnerDebug is not accessible from the gale module

token() 🔗

GitHub token to use for authentication.

Return Type
Secret !
Example
Function GaleWorkflowRunConfig.Token is not accessible from the gale module
Function GaleWorkflowRunConfig.Token is not accessible from the gale module
Function GaleWorkflowRunConfig.Token is not accessible from the gale module
Function GaleWorkflowRunConfig.Token is not accessible from the gale module