Context State

Upon flow execution each action handler gets access to shared context.
​EJS template can be used inside options to pass values from shared context. Please refer to plugin documentation if this feature supported and what options are required.
Example:
version: 1.0.0
pipeline:
  plugin:
    # Pass "something" from "ctx"
    contextValue: <%- ctx.something  %>
    # Pass "password" from "secrets"
    secretValue: <%- secrets.password %>
Action Handler: Context Values Assignment
Assign non-secret values to context ctx field or its child properties by path. General use case: register shared non-sensitive options that later will be used by actions.
ID: com.fireblink.fbl.context.values
Aliases:
fbl.context.values
context.values
context
ctx
Example 1: Assign values to context root directly:
ctx:
  # assign to "ctx" directly
  '$':
    inline:
      something: true
      else: false
Example 2: Assign values from file "vars.yml" to field "vars -> files":
ctx:
  # create hierarchy of objects: "files" inside "vars" that is inside "ctx"
  $.vars:
    files:
      - vars.yml
Example 3: Assign values from file "vars.yml" after inline ones:
ctx:
  '$':
    inline:
      test: true
    files:
      - vars.yml
    # specify that files have a priority over inline vars
    # if not provided inline vars will have priority over files
    priority: 'files'
Example 4: Override instead of assigning
ctx:
  '$.test':
    inline:
      test: true
    # [optional] override everything tha tis inside "test" object with { test: true }
    # use with caution
    override: true
Example 5: Push to array
ctx:
  '$.test':
    inline: 1
    # [optional] override everything tha tis inside "test" object with { test: true }
    # use with caution
    override: true
    # [required] if you want to push inline or value(s) from file(s) to targets array
    push: true
    # [optional] if enambled and value is array its child items will be pushed instead of array itself
    children: false
Example 6: Find files by mask:
ctx:
  '$':
    files:
      - vars/*.yml
Action Handler: Secret Values Assignment
Same as above, but for secrets. All the options will me masked in report to prevent any security leakage.
ID: com.fireblink.fbl.secret.values
Aliases:
fbl.secret.values
secret.values
secrets
secret
Example 1: Assign values to secrets root directly:
secrets:
  '$':
    inline:
      something: true
      else: false
Example 2: Assign values from file "vars.yml" to field "vars -> files":
secrets:
  $.vars:
    files:
      - vars.yml
Example 3: Assign values from file "vars.yml" after inline ones:
secrets:
  '.':
    inline:
      test: true
    files:
      - vars.yml
​
    # [optional] specify that files have a priority over inline vars
    # if not provided inline vars will have priority over files
    priority: 'files'
Example 4: Override instead of assigning
secrets:
  '$.test':
    inline:
      test: true
    # [optional] override everything tha tis inside "test" object with { test: true }
    # use with caution
    override: true
Example 5: Push to array
secrets:
  '$.test':
    inline: 1
    # [optional] override everything tha tis inside "test" object with { test: true }
    # use with caution
    override: true
    # [required] if you want to push inline or value(s) from file(s) to target's array
    push: true
    # [optional] if enambled and value is array its child items will be pushed instead of array itself
    children: false
Example 6: Find files by mask:
secrets:
  '$':
    files:
      - vars/*.yml
Action Handler: Mark entities as registered
Mark some entity as registered, meaning it supposed to exist.
Example use case: you want to keep some default entity upon cleanup that is not created/update with your script, but script itself in the end has some cleanup logic based on "registered" entities list.
ID: com.fireblink.fbl.context.entities.registered
Aliases:
fbl.context.entities.registered
context.entities.registered
entities.registered
Example:
entities.registered:
  # Object type/class/etc
  - type: User
    # Entity Identity, can be a string or number
    id: 1002
    # [optional] payload that may represent other or all fields of the entity
    payload:
      username: foobar
Action Handler: Mark entities as un-registered
Opposite to one above. Mark some entity to no longer exist.
ID: com.fireblink.fbl.context.entities.registered
Aliases:
fbl.context.entities.unregistered
context.entities.unregistered
entities.unregistered
Example:
entities.unregistered:
  # Object type/class/etc
  - type: User
    # Entity Identity, can be a string or number
    id: 1002
    # [optional] payload that may represent other or all fields of the entity
    payload:
      username: foobar
Action Handler: Mark entities as created
Mark some entity as just created. Will also register entity, so it will be presented in 2 places: entities.registered and entities.created
ID: com.fireblink.fbl.context.entities.created
Aliases:
fbl.context.entities.created
context.entities.created
entities.created
Example:
entities.created:
  # Object type/class/etc
  - type: User
    # Entity Identity, can be a string or number
    id: 1002
    # [optional] payload that may represent other or all fields of the entity
    payload:
      username: foobar
Action Handler: Mark entities as updated
Mark some entity as just updated. Will also register entity, so it will be presented in 2 places: entities.registered and entities.updated
ID: com.fireblink.fbl.context.entities.updated
Aliases:
fbl.context.entities.updated
context.entities.updated
entities.updated
Example:
entities.created:
  # Object type/class/etc
  - type: User
    # Entity Identity, can be a string or number
    id: 1002
    # [optional] payload that may represent other or all fields of the entity
    payload:
      username: foobar
Action Handler: Mark entities as deleted
Mark some entity as just deleted. Will also un-register entity, so it will be presented in 2 places: entities.unregistered and entities.deleted
ID: com.fireblink.fbl.context.entities.deleted
Aliases:
fbl.context.entities.deleted
context.entities.deleted
entities.deleted
Example:
entities.deleted:
  # Object type/class/etc
  - type: User
    # Entity Identity, can be a string or number
    id: 1002
    # [optional] payload that may represent other or all fields of the entity
    payload:
      username: foobar
Action Handler: Summary
Add summary record. All summary records will be printed once the main flow ends.
ID: com.fireblink.fbl.context.summary
Aliases:
fbl.context.summary
context.summary
summary
Example:
summary:
  # summary record title
  title: Step Title
  # summary record status
  # statuses (ignoring case):
  # - 'created', 'updated', 'passed', 'success', 'ok', 'yes' will be colored in green
  # - 'deleted', 'failed', 'failure', 'error', 'no' - in red
  # - 'ignored', 'skipped', 'none' - in yellow
  # others will have default text color
  status: Failed
  # [optional] human readable duration (string)
  duration: <%- $.duration(1000) %>
  # [optional] additional data associated with record. Not presented in printed table.
  payload: anything
Flow Control
Execute (Shell & JavaScript)
Last updated 3 weeks ago