Enumeration
CompositeAction
Factory and runtime for user-defined composite actions declared in Shipfile.yml under custom_actions:.
enum CompositeActionOverview
A custom action is a named, parameterized sequence of other action steps. At registration time each CustomActionConfig is converted into an ActionDescriptor that, when invoked, substitutes call-site parameters into each sub-step’s options and dispatches through the shared ActionRegistry.
Parameter substitution
String leaves inside a step’s options: block may reference declared parameters using the {{param.NAME}} syntax. The substitution runs after Shipfile’s ${ENV_VAR} expansion and does not collide with GitHub Actions’ ${{ ... }} or CircleCI’s << ... >> templating.
When a string is exactly
{{param.NAME}}, the typed JSON value of the parameter is substituted (preservingbool,int,array, etc.).When a string contains
{{param.NAME}}interpolated with other text, the parameter is stringified into the surrounding string.
Topics
Type Methods
static func descriptor(name: String, config: CustomActionConfig, registry: ActionRegistry) -> ActionDescriptorBuild an
ActionDescriptorfor the given composite definition that delegates sub-steps through the provided registry at run time.static func parameterSchema(for: CustomActionConfig) -> [SchemaField]Projects a composite’s declared parameters into a
SchemaFieldarray soshipit schemaand validation surfaces call-site options.
Enumerations
enum CompositeErrorError namespace for composite-action authoring mistakes surfaced at registration or runtime.