import type { WorkflowContextName, WorkflowContextReservedRoot } from './workflow-context.js'; /** * Reader-facing descriptions for every context root and property. * * They live beside the type registry so a new field cannot ship undescribed: * the documentation generator renders types from the registry and looks up each * property here, and its check fails on a property with no description or a * description for a property that no longer exists. */ export interface WorkflowContextDoc { readonly root: WorkflowContextName | WorkflowContextReservedRoot; readonly summary: string; /** Why an open-shape root has no property table. */ readonly shapeNote?: string; /** Prefix shown in the property column, such as `needs[*].`. */ readonly propertyPrefix?: string; /** Description per property path, relative to the root. */ readonly fields?: Readonly>; /** Paths whose element shape another root already documents. */ readonly collapse?: readonly string[]; } export declare const workflowContextDocs: readonly [{ readonly root: 'workflow'; readonly summary: 'The workflow definition this run came from.'; readonly fields: { readonly id: 'Identifier of the workflow definition.'; readonly name: 'Workflow `name` from the definition.'; }; }, { readonly root: 'run'; readonly summary: 'The current run.'; readonly fields: { readonly id: 'Identifier of the run.'; readonly number: 'Sequential run number within the workflow definition.'; readonly attempt: 'Attempt number of the current run, starting at one.'; readonly name: 'Resolved run name, or the workflow name when `run_name` is not set.'; readonly project_id: 'Identifier of the project that owns the run.'; readonly workspace_id: 'Identifier of the workspace that owns the run.'; readonly created_at: 'Time the run was created.'; }; }, { readonly root: 'trigger'; readonly summary: 'The trigger that started the run.'; readonly fields: { readonly source: 'Integration connection slug, or `manual` or `cron`.'; readonly event: 'Shipfox event name that matched the trigger.'; readonly project: 'Shipfox project resolved from the event repository. Null when there is none.'; readonly 'project.id': 'Identifier of the resolved project.'; readonly repository: 'Repository the event came from, as `owner/name`. Null when there is none.'; readonly ref: 'Git ref the event carried. Null when there is none.'; readonly commit: 'Commit SHA the event carried. Null when there is none.'; }; }, { readonly root: 'event'; readonly summary: 'The raw payload of the event that started the run.'; readonly shapeNote: 'The provider owns this payload, so it has no fixed shape. Each provider page under [Integrations](/integrations) lists the events Shipfox delivers and links the payload each one carries.'; }, { readonly root: 'inputs'; readonly summary: 'Values the trigger `with` block passed into the run.'; readonly shapeNote: 'The keys are the ones the trigger declares. See [trigger fields](/reference/workflow-schema#trigger-fields).'; }, { readonly root: 'job'; readonly summary: 'The current job.'; readonly fields: { readonly key: 'Key of the job in the `jobs` map.'; readonly name: 'Job `name`, or the job key when no name is set.'; }; }, { readonly root: 'executions'; readonly summary: 'Every execution of the current job.'; readonly propertyPrefix: 'executions[*].'; readonly fields: { readonly index: 'Position of the execution in its job, starting at zero.'; readonly name: 'Resolved execution name, or the job name when `execution_name` is not set.'; readonly status: 'Final status of the execution.'; readonly started_at: 'Time the execution started.'; readonly finished_at: 'Time the execution finished.'; readonly events: 'Listener events in the batch that started this execution. Empty for a standard job.'; readonly 'events[*].event_ref': 'Stable identifier for the listener event.'; readonly 'events[*].source': 'Integration connection slug that delivered the event.'; readonly 'events[*].event': 'Shipfox event name.'; readonly 'events[*].delivery_id': 'Identifier of the provider delivery.'; readonly 'events[*].received_at': 'Time Shipfox received the event.'; readonly 'events[*].disposition': 'Whether the listener event fired an execution or resolved the listener.'; readonly 'events[*].outcome': 'Processing outcome recorded for the listener event.'; readonly 'events[*].outcome_reason': 'Reason recorded when the listener event was rejected or abandoned.'; readonly 'events[*].stored_payload_bytes': 'Bytes stored for the event payload.'; readonly 'events[*].normalized_event_bytes': 'Bytes in the normalized event sent to execution.'; readonly 'events[*].project': 'Shipfox project resolved from the event repository. Null when there is none.'; readonly 'events[*].project.id': 'Identifier of the resolved project.'; readonly 'events[*].repository': 'Repository the event came from, as `owner/name`. Null when there is none.'; readonly 'events[*].ref': 'Git ref the event carried. Null when there is none.'; readonly 'events[*].commit': 'Commit SHA the event carried. Null when there is none.'; readonly 'events[*].data': 'Raw event payload. The provider owns its shape.'; readonly outputs: 'Outputs the execution produced, keyed by output name.'; }; }, { readonly root: 'execution'; readonly summary: 'The current execution of the job.'; readonly fields: { readonly index: 'Position of the execution in its job, starting at zero.'; readonly name: 'Resolved execution name, or the job name when `execution_name` is not set.'; readonly status: 'Final status of the execution.'; readonly started_at: 'Time the execution started.'; readonly finished_at: 'Time the execution finished.'; readonly events: 'Listener events in the batch that started this execution. Empty for a standard job.'; readonly 'events[*].event_ref': 'Stable identifier for the listener event.'; readonly 'events[*].source': 'Integration connection slug that delivered the event.'; readonly 'events[*].event': 'Shipfox event name.'; readonly 'events[*].delivery_id': 'Identifier of the provider delivery.'; readonly 'events[*].received_at': 'Time Shipfox received the event.'; readonly 'events[*].disposition': 'Whether the listener event fired an execution or resolved the listener.'; readonly 'events[*].outcome': 'Processing outcome recorded for the listener event.'; readonly 'events[*].outcome_reason': 'Reason recorded when the listener event was rejected or abandoned.'; readonly 'events[*].stored_payload_bytes': 'Bytes stored for the event payload.'; readonly 'events[*].normalized_event_bytes': 'Bytes in the normalized event sent to execution.'; readonly 'events[*].project': 'Shipfox project resolved from the event repository. Null when there is none.'; readonly 'events[*].project.id': 'Identifier of the resolved project.'; readonly 'events[*].repository': 'Repository the event came from, as `owner/name`. Null when there is none.'; readonly 'events[*].ref': 'Git ref the event carried. Null when there is none.'; readonly 'events[*].commit': 'Commit SHA the event carried. Null when there is none.'; readonly 'events[*].data': 'Raw event payload. The provider owns its shape.'; readonly outputs: 'Outputs the execution produced, keyed by output name.'; readonly failed: 'Whether an earlier step in this execution failed.'; }; }, { readonly root: 'jobs'; readonly summary: 'Upstream jobs, keyed by job key.'; readonly shapeNote: 'The keys are the job keys the workflow declares.'; readonly propertyPrefix: 'jobs..'; readonly fields: { readonly key: 'Key of the job in the `jobs` map.'; readonly status: 'Final status of the job.'; readonly outputs: 'Declared job outputs, keyed by output name.'; readonly executions: 'Executions of the job, each with the properties of the `execution` context. A standard job has one.'; }; readonly collapse: readonly ["executions"]; }, { readonly root: 'needs'; readonly summary: 'The jobs this job declares in `needs`.'; readonly propertyPrefix: 'needs[*].'; readonly fields: { readonly key: 'Key of the job in the `jobs` map.'; readonly status: 'Final status of the job.'; readonly outputs: 'Declared job outputs, keyed by output name.'; readonly executions: 'Executions of the job, each with the properties of the `execution` context. A standard job has one.'; }; readonly collapse: readonly ["executions"]; }, { readonly root: 'steps'; readonly summary: 'Earlier steps of the current job, keyed by step key.'; readonly shapeNote: 'The keys are the step keys the workflow declares.'; readonly propertyPrefix: 'steps..'; readonly fields: { readonly status: 'Final status of the step.'; readonly exit_code: 'Exit code of the most recent finished attempt.'; readonly outputs: 'Declared step outputs of the most recent finished attempt.'; readonly response: 'Final agent response. Absent on a run step.'; readonly gate: 'Gate result of the most recent finished attempt. Absent when the step has no gate.'; readonly 'gate.passed': 'Whether the gate expression passed.'; readonly 'gate.source': 'Gate expression that produced the result.'; readonly 'gate.reason': 'Why Shipfox could not check the gate.'; readonly 'gate.exit_code': 'Exit code the gate read.'; readonly attempts: 'Every finished attempt of the step, oldest first.'; readonly 'attempts[*].status': 'Final status of the attempt.'; readonly 'attempts[*].exit_code': 'Exit code the attempt reported.'; readonly 'attempts[*].outputs': 'Declared outputs the attempt reported.'; readonly 'attempts[*].response': 'Final agent response of the attempt. Absent on a run step.'; readonly 'attempts[*].gate': 'Gate result of the attempt. Absent when the step has no gate.'; readonly 'attempts[*].gate.passed': 'Whether the gate expression passed.'; readonly 'attempts[*].gate.source': 'Gate expression that produced the result.'; readonly 'attempts[*].gate.reason': 'Why Shipfox could not check the gate.'; readonly 'attempts[*].gate.exit_code': 'Exit code the gate read.'; }; }, { readonly root: 'step'; readonly summary: 'The current step. Its properties depend on the field that reads it.'; readonly fields: { readonly attempt: 'Attempt number of the step, starting at one. Not readable in `gate.success`.'; readonly is_retry: 'Whether the current step ran before. This does not identify which gate failed. Not readable in `gate.success`.'; readonly restart: 'Set when a gate failure causes Shipfox to run this step again. It remains set for later steps after the gate passes. A later gate restart replaces it. Not readable in `gate.success`.'; readonly 'restart.from': 'The gate step whose failure caused the restart. It includes the properties of a `steps` entry and its optional authored `key`. The key identifies the failed gate, not the restart target. Not readable in `gate.success`.'; readonly 'restart.feedback': 'Feedback the restarting gate produced. Not readable in `gate.success`.'; readonly exit_code: 'Exit code the step reported. Readable in `gate.success` only.'; readonly status: 'Status the step reported. Readable in `gate.success` only.'; readonly outputs: 'Outputs the step reported. Readable in `gate.success` only.'; }; readonly collapse: readonly ["restart.from"]; }, { readonly root: 'vars'; readonly summary: 'Workspace and project variables.'; readonly shapeNote: 'The keys are the variable names the workspace defines. See [Manage secrets and variables](/how-to/set-up-work/secrets-and-variables).'; }, { readonly root: 'secrets'; readonly summary: 'Workspace and project secrets.'; readonly shapeNote: 'The keys are the secret names the workspace defines. See [Manage secrets and variables](/how-to/set-up-work/secrets-and-variables).'; }, { readonly root: 'result'; readonly summary: 'The result returned by the current tool step.'; readonly shapeNote: 'The selected tool catalog defines this value. It is readable only while mapping tool outputs at step reporting.'; }]; //# sourceMappingURL=workflow-context-docs.d.ts.map