| api-base | Path to the Distr API, must end with /api/v1
Defaults to https://app.distr.sh/api/v1 – if you are self hosting set to, e.g. https://distr.example.com/api/v1
| no | — |
| api-token | Personal Access Token used to authenticate with the Distr API, also see https://distr.sh/docs/integrations/personal-access-token/
| yes | — |
| application-id | ID of the application that the version will be created in.
You can find and easily copy this ID in the list of applications in the Distr Web UI.
| yes | — |
| version-name | Name of the version that will be created | yes | — |
| compose-file | Absolute path to the Docker Compose File inside the runner (required for docker applications).
| no | — |
| chart-type | Helm Chart Type (required for helm applications, allowed: "repository" or "oci")
| no | — |
| chart-name | Helm Chart Name (required for helm applications if chart-type is "repository") | no | — |
| chart-version | Helm Chart Version (required for helm applications) | no | — |
| chart-url | Helm Chart URL (required for helm applications) | no | — |
| base-values-file | Absolute path to the base values file for helm applications. | no | — |
| template-file | Absolute path to template file for both helm and docker applications. | no | — |
| link-template | Link template for accessing deployed applications. Use template variables like {{ .Env.VARIABLE_NAME }}
to dynamically generate links based on deployment environment variables.
Example: http://{{ .Env.HELLO_DISTR_HOST }}
| no | — |
| resources | JSON array of resources to attach to the application version.
Each resource must have a "name" and either "content" (inline string) or "path" (file path on the runner).
Optionally set "visibleToCustomers" (defaults to true).
Example:
Example:
```json
[
{ "name": "Getting Started", "path": "./docs/getting-started.md", "visibleToCustomers": true },
{ "name": "Release Notes", "content": "# v1.0.0\n\nInitial release." }
]
```
```
| no | — |
| update-deployments | If set to true, all deployments of the application will be updated to the newly created version.
This will update all deployment targets where this application is deployed.
| no | false |
| reuse-deployment-config | If set to true and update-deployments is also true, updated deployments will use the same configuration
as the previous revision.
| no | false |