Skip to content

Enumeration

CompositeAction

Factory and runtime for user-defined composite actions declared in Shipfile.yml under custom_actions:.

enum CompositeAction

Overview

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 (preserving bool, int, array, etc.).

  • When a string contains {{param.NAME}} interpolated with other text, the parameter is stringified into the surrounding string.

Topics

Type Methods

Enumerations

  • enum CompositeError

    Error namespace for composite-action authoring mistakes surfaced at registration or runtime.