https://github.com/boomerang-io/flow.action

Boomerang Flow GitHub Action
https://github.com/boomerang-io/flow.action

Last synced: about 6 hours ago
JSON representation

Boomerang Flow GitHub Action

• Host: GitHub
• URL: https://github.com/boomerang-io/flow.action
• Owner: boomerang-io
• Created: 2021-07-26T06:05:44.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-01T06:47:57.000Z (over 2 years ago)
• Last Synced: 2024-03-14T20:21:57.706Z (8 months ago)
• Language: JavaScript
• Size: 381 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:///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](https://www.useboomerang.io/docs/boomerang-flow/architecture/eventing-architecture)

## 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.