https://github.com/robocorp/action-trigger-process
GitHub action to trigger a process run in Robocorp Cloud
https://github.com/robocorp/action-trigger-process
Last synced: about 1 year ago
JSON representation
GitHub action to trigger a process run in Robocorp Cloud
- Host: GitHub
- URL: https://github.com/robocorp/action-trigger-process
- Owner: robocorp
- License: apache-2.0
- Created: 2020-12-07T09:38:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T03:59:27.000Z (almost 3 years ago)
- Last Synced: 2025-04-25T10:54:40.515Z (about 1 year ago)
- Language: TypeScript
- Size: 380 KB
- Stars: 25
- Watchers: 10
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action to trigger a Robocorp Control Room process
This GitHub Actions triggers a Robocorp Control Room process run and optionally waits for its execution to complete.
## Usage
### Example Workflow file
An example workflow to trigger and await a Control Room process run:
```yaml
jobs:
run-process:
runs-on: ubuntu-latest
name: Trigger process
steps:
- name: Trigger Control Room 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 Control Room workspace ID |
| process-id | string | \* | | The target Control Room process ID |
| payload | string | | "{}" | Stringified JSON payload passed to process |
| await-complete | boolean | | false | Should the action await process run completion |
| fail-on-robot-fail | boolean | | true | Fail the GitHub workflow run if Control Room process fails |
| timeout | number | | 120 | Process run await timeout in seconds |
| api-endpoint | string | | https://api.eu1.robocloud.eu/process-v1 | Robocorp workspace API endpoint |
#### Outputs
| Name | Value | Description |
| ------------ | ------------------------------------- | --------------------------------------------- |
| run-id | string | Process run id |
| duration | number | Process run execution duration |
| robotrun-ids | string | Comma seperated list of process robot run IDs |
| state | "COMPL" | "ERR" | "TIMEOUT" | Process run state code |