Shipfox integration

The built-in Shipfox integration sends events about workflow runs and jobs, so one workflow can start after another. Its tools let workflow steps start other workflows. They also let agent steps inspect projects, workflow definitions, runs, logs, and annotations.

Authentication

Shipfox events and tools require no external account, credentials, or setup. Shipfox tools use the identity of the calling workflow.

Shipfox tools can only access data in the same workspace as the workflow. A trigger receives Shipfox events only from runs in its own workspace.

Events

Set source: shipfox in a trigger to start a workflow from a run or a job in the same workspace. This trigger starts a workflow after a build run succeeds. Its filter chooses the runs:

triggers:
  after_build:
    source: shipfox
    event: run.completed
    filter: >-
      event.project.name == 'api'
      && event.workflow.path == '.shipfox/workflows/build.yml'
      && event.run.origin == 'synced'
      && event.run.status == 'succeeded'

A run.completed event carries the run's workflow outputs when the run succeeds. A job.completed event carries the job's outputs when the job succeeds.

For trigger field rules, see the workflow schema reference.

Use Shipfox tools

Set connection: shipfox in a tool step or agent integration.

Capabilities

Run a workflow after another one finishes, and publish workflow outputs for the next workflow to read. Use a deterministic tool step to start another workflow. Give an agent read-only tools to inspect other runs.