Zekt Action inputs and outputs
zekt-dev-org/zekt-action@v3. The job must have permissions: id-token: write: the action signs in
to Zekt with GitHub OIDC and takes no secret or token.
Inputs
Section titled “Inputs”No input is strictly required, but some are needed depending on what you do.
| Input | Default | Description |
|---|---|---|
event-type | — | The event type consumers listen for. Required to send a normal event. Not used with orchestrate: true, or when a service run started by an orchestration step reports its outputs. |
payload | {} | Must be JSON. The event’s payload, or, with orchestrate: true, the orchestration plan. |
shield | false | Encrypt the payload with Zekt Shield. |
orchestrate | false | Submit an orchestration plan instead of sending an event. |
execution_mode | sequential | Orchestration only. The plan’s own execution_mode takes precedence. |
wait | false | Orchestration only. Wait for the orchestration to finish, checking every 30 seconds. |
zekt-api-url, orchestration-api-url | Built in (leave unset) | Leave these unset. |
Outputs
Section titled “Outputs”| Output | When set | Description |
|---|---|---|
status | When sending an event (not with orchestrate: true) | success when the call succeeded. |
execution_id | orchestrate: true | The orchestration’s ID. |
execution_status | orchestrate: true and wait: true | completed, failed or timed_out. |
step_<step_id>_outputs_<field> | orchestrate: true and wait: true | One output per step output field. |
Output values are strings. An object value comes through unusable, so have services return scalar outputs.
Failures
Section titled “Failures”- Any refusal from Zekt fails the step with the server’s error message.
- With
wait: true, an orchestration that fails or times out fails the step, and so the job, unless the step setscontinue-on-error. - With
shield: true, the step fails if no subscriber has uploaded a public key. Nothing is sent unencrypted. - Advisory warnings about an orchestration plan appear as
::warning::annotations in the workflow log.
Modes at a glance
Section titled “Modes at a glance”| You want to | Use |
|---|---|
| Send an event with a payload | event-type + payload |
| Send an encrypted payload | event-type + payload + shield: true |
| Run several services in order | orchestrate: true + payload (the plan), optionally wait: true |
| Report outputs from a service run started by an orchestration step | payload only (no event-type), in the service’s workflow |