Skip to content
play-circle

GitHub Action

Boomerang Flow Run Workflow

v0.6.4 Latest version

Boomerang Flow Run Workflow

play-circle

Boomerang Flow Run Workflow

Trigger a workflow to execute

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Boomerang Flow Run Workflow

              
  uses: boomerang-io/flow.action@v0.6.4
Learn more about this action in boomerang-io/flow.action

Choose a version

Boomerang Flow GitHub Action

This action will run a workflow in Boomerang Flow by publishing a CloudEvent to the event listener.

Inputs

Input Description Default Required
URL The Boomerang Flow event URL. https://<host>/flow/services/listener/event true
Token The security token as part of your workflow true
Workflow ID The ID of the workflow that you want to run. true
Topic This is entered in the Workflow configuration when you enable a Custom event 'GitHub' true
Payload The JSON payload you would like sent. false

Find more information at our documentation

How to set up your Workflow

In your Boomerang Flow instance, for the Workflow you wish to run

  1. Navigate to the Edit Workflow > Configuration > Triggers and enable the Custom Event trigger.
  2. Set the Topic to the value you will specify in the Inputs mentioned above.
  3. Hit Save.

Release Management

When creating new versions of this GitHub Action, you will need to navigate to the action.yaml and update the version of the container to match.