# GitHub Action

> The inputs and outputs of the Sluice GitHub Action.

<!-- Generated by `just gen` from action.yml. Do not edit this file. -->

This page lists the inputs and outputs of the GitHub Action `alternayte/sluice`. Start a flow on a Sluice server, stream its logs, and fail the job when the flow does not succeed.

## Inputs

| Input | Required | Default | Description |
|---|---|---|---|
| `url` | yes | empty | Base URL of the Sluice server, for example https://sluice.example.com. |
| `token` | yes | empty | Sluice API token with at least the operator role. Store it as a repository secret. |
| `flow` | yes | empty | Flow to run, as &lt;namespace&gt;/&lt;flow&gt;. |
| `inputs` | no | empty | Flow inputs, one key=value per line. A JSON value keeps its type (7, true, {"a":1}). |
| `labels` | no | empty | Execution labels, one key=value per line. |
| `timeout` | no | empty | Stop waiting after this duration, for example 30m. The job then fails with exit code 14, and the execution continues. Empty waits until the end. |
| `version` | no | empty | Release tag of the sluice CLI, for example v0.2.1. Empty uses the tag of this action, or the latest release when the action ref is not a tag. |

## Outputs

| Output | Description |
|---|---|
| `execution-id` | ID of the execution. |
| `state` | State of the execution, for example SUCCESS or FAILED. Empty when the run did not start. |
| `url` | URL of the execution page. |

The step fails with the exit code of `sluice run --wait`. [Exit codes](/reference/exit-codes/) lists them. [Run flows from GitHub Actions](/how-to/run-flows-from-github-actions/) shows a workflow.