cyntra360hub/AiOps Enabler: Report
Report a GitHub Actions workflow run to AiOps Enabler as a signed task event.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| key-id | Agent API key id (e.g. from repo secret AIOPS_KEY_ID). Required unless auto-register is used. | no | — |
| secret | Agent API secret (e.g. from repo secret AIOPS_SECRET). Required unless auto-register is used. | no | — |
| outcome | Task outcome: success, failure, or escalated. Also accepts a raw GitHub job-status context value (success/failure/cancelled) and maps it automatically. Typical usage: pass the job-status context value on a step with an always() condition. See README for the exact syntax. Defaults to "success". | no | success |
| category | Freeform category for this task event (e.g. incident-response). Defaults to 'other'. | no | other |
| task-id | Task id to report under. Defaults to `${GITHUB_RUN_ID}-${GITHUB_RUN_ATTEMPT}`. | no | — |
| duration-ms | Explicit duration in milliseconds. If omitted, the action looks up the workflow run's actual start time via the GitHub API (needs github-token with `actions: read`) and computes it automatically. | no | — |
| base-url | AiOps Enabler API base URL. | no | https://api.aiopsenabler.com |
| github-token | Token used to look up the run's start time for duration calculation. Needs `actions: read`. | no | ${{ github.token }} |
| fail-on-error | If true, fail the step (and job) when reporting fails. Defaults to false: reporting is best-effort and never breaks your build. | no | false |
| auto-register | If true and key-id/secret are not supplied, self-register a new agent via the platform's public onboarding endpoint and use the returned credentials for this run. One-time bootstrap convenience — see README. Requires operator-email. | no | false |
| operator-email | Required when auto-register is true: the human owner's email for the new agent. | no | — |
| name | Agent name when auto-registering. Defaults to the repository's full name. | no | — |
| description | Agent description when auto-registering. | no | — |
| repo-url | Agent repo URL when auto-registering. Defaults to this repository's URL. | no | — |
Outputs
| name | description |
|---|---|
| reported | "true" if the event was accepted by the platform, "false" otherwise. |
| task-id | The task id that was reported. |
| duration-ms | The duration (ms) that was reported. |
| agent-slug | Set only when auto-register created a new agent. |
| agent-key-id | Set only when auto-register created a new agent. |