Structure

ActionDescriptor

Type-erased registration metadata used by CLI commands, Shipfile workflows, and plugins to resolve actions by name at runtime.

struct ActionDescriptor

Topics

let description: String
Human-readable description of the action.
let name: String
The unique action name (matches Action.name).
let optionSchema: [SchemaField]
Machine-readable workflow option schema for this action.
let platforms: Set<Platform>?
The platforms this action supports. nil means supported on all platforms.
let runJSON: (JSONValue?, ActionContext) async throws -> ActionResultEnvelope
Type-erased execution closure. Accepts optional JSON options and returns a result envelope.
let validationRules: [ActionValidationRule]
Semantic validation rules evaluated during shipit validate yml for every workflow step that references this action.