/action-trigger-process

GitHub action to trigger a process run in Robocorp Cloud

Primary LanguageTypeScriptApache License 2.0Apache-2.0

GitHub Action to trigger a Robocorp Cloud process

This GitHub Actions triggers a Robocorp Cloud process run and optionally waits for its execution to complete.

Usage

Example Workflow file

An example workflow to trigger and await a Robocorp Cloud process run:

jobs:
  run-process:
    runs-on: ubuntu-latest
    name: Trigger process
    steps:
      - name: Trigger Robocorp Cloud process run
        uses: robocorp/action-trigger-process@v1
        with:
          api-key: ${{ secrets.ROBOCORP_API_KEY }}
          workspace-id: ${{ secrets.ROBOCORP_WORKSPACE_ID }}
          process-id: ${{ secrets.ROBOCORP_PROCESS_ID }}
          payload: '{"foo":"bar"}'
          await-complete: true
Configuration
Option Value Required Default Description
api-key string * Workspace API key with read_runs and trigger_processes permissions
workspace-id string * The target Robocorp Cloud workspace ID
process-id string * The target Robocorp Cloud process ID
payload string "{}" Stringified JSON payload passed to process
await-complete boolean false Should the action await process run completion
timeout number 120 Process run await timeout in seconds
api-endpoint string https://api.eu1.robocloud.eu/process-v1 Robocorp workspace API endpoint