Skip to content
Proud to collaborate with Microsoft for Startups

runner.scale-check-group ​

Reconcile active executions for a runner group, then launch enough runners to satisfy max(min_count, demand) up to max_count. min_count is the warm-pool floor — runners kept registered with GitHub so incoming jobs claim them instantly instead of paying the cold-start cost. Called on webhook arrival, on execution-stop completion (queue-drain chain), and from periodic sweeps. Self-healing via execution-claim-watch timeout.

Demand-driven scaling primitive: reconcile + launch up to max_count.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-runners
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidYes—UUID of the RunnerGroup to scale-check, picked from the organization's list of runner groups.
actor_uuiduuidNo—UUID of the user or service actor who triggered this scale-check, injected server-side from the authenticated request when available; used for audit/attribution only. Omitted for system-triggered calls (webhook, periodic sweep) with no human actor.
batch_limitintegerNo—Cap on number of runners to launch this call. Defaults to (max_count - active) — the full headroom.

Output Schema ​

FieldTypeRequiredDefaultDescription
runner_group_uuiduuidNo—UUID of the RunnerGroup this action operates on, picked from the organization's list of runner groups; echoed on output alongside terminal/error payloads.
organization_uuiduuidNo—UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. Echoed on output alongside terminal/error payloads.
runner_execution_uuiduuidNo—UUID of the RunnerExecution this action operates on, picked from the organization's (optionally group-scoped) list of executions; echoed on output alongside terminal/error payloads.
workflow_uuidstringNo—Engine workflow-run identifier (or, for GitHub-Actions-triggered flows, an external GitHub Actions run id) associated with this record; not a platform entity foreign key despite the name. No source is attached since there is no list/query workflow for an internal run id.
statusstringNo——
outcomestringNo——
initiated_atstringNo——
completed_atstringNo——
failed_atstringNo——
failure_reasonstringNo——
errorstringNo——
error_typestringNo——
actor_uuiduuidNo—UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. Optional — omitted for system or service-triggered actions with no human actor.
reasonstringNo——
workflow_run_uuidstringNo—Engine-stamped correlation/run id for this DAG execution (ADR-015/E1 plumbing), written into state_data by action_start; not a foreign key to any business entity. No source is attached since there is no list/query workflow for an internal run id.
retry_countintegerNo——
retried_fromstringNo——
failed_stepjsonNo——
failed_layerjsonNo——
failed_at_statejsonNo——
compensation_triggerjsonNo——
comp_current_layerjsonNo——
comp_queuejsonNo——
comp_retry_countjsonNo——
batch_limitintegerNo——
matched_runner_group_uuiduuidNo—UUID of the RunnerGroup matched during this scale-check, echoed on output; picked from the organization's runner groups.
reconciled_executionsintegerNo——
active_execution_countintegerNo——
ready_to_serveintegerNo——
instance_countsdictNo——
warm_pool_enabledbooleanNo——
max_countintegerNo——
min_countintegerNo——
floor_deficitintegerNo——
launched_countintegerNo——
launched_workflow_uuidstringNo—Engine run id of the first runner.execution-launch-* workflow started by this scale-check pass, when one was launched. Internal engine correlation id, not a business entity reference.
launched_workflow_uuidslistNo——
launched_workflow_typestringNo——
launch_errorslistNo——
scale_actionstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—check—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingcheckcompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "runner.scale-check-group",
  "initial_data": {
    "runner_group_uuid": "value"
  }
}