| stack-name | Name of the stack to deploy. Defaults to the repository name. | — | — |
| version | Version for the deployment. Defaults to the tag name being built, or the commit hash. | — | — |
| compose-file | Path to the Docker Compose file(s) to use for deployment relative to the repository root. Separate multiple files
with colons (`:`). If omitted, the action will look for any of the following file variants, in order:
- `compose.production.yaml`
- `compose.production.yml`
- `compose.prod.yaml`
- `compose.prod.yml`
- `compose.yaml`
- `compose.yml`
- `docker-compose.production.yaml`
- `docker-compose.production.yml`
- `docker-compose.prod.yaml`
- `docker-compose.prod.yml`
- `docker-compose.yaml`
- `docker-compose.yml`
- `.docker/compose.yaml`
- `.docker/compose.yml`
- `.docker/docker-compose.yaml`
- `.docker/docker-compose.yml`
- `docker/compose.yaml`
- `docker/compose.yml`
- `docker/docker-compose.yaml`
- `docker/docker-compose.yml` | — | — |
| variables | Variables to pass to the deployment as a list of key-value pairs in the format `KEY=value`, separated by newlines, or as JSON object (e.g., from `toJSON(vars)`). Variables override those in the process environment and can be used to pass through secrets or configs. | — | "" |
| secrets | Variables to pass to the deployment as a list of key-value pairs in the format `KEY=value`, separated by newlines, or as JSON object (e.g., from `toJSON(secrets)`). Secrets have higher priority than variables and override those in the process environment. | — | "" |
| exclude-variables | List of variable names to exclude from the final deployment, separated by newlines. Applies to variables from environment, variables, and secrets sources. Does not affect extra-variables which have highest priority. | — | "" |
| extra-variables | Additional variables to pass to the deployment as a list of key-value pairs in the format `KEY=value`, separated by newlines, or as JSON object. These have the highest priority and override all other variable sources. | — | "" |
| env-var-prefix | Prefix filter for environment variables to automatically load as secrets. | — | DEPLOYMENT |
| manage-variables | Whether to automatically manage configs and secrets. If set to `false`, the action will leave the configs and secrets in the stack untouched. | — | true |
| strict-variables | Whether to disable automatic fallback to matching environment variables for file variable sources that don't exist in the working directory. This is useful for ensuring that the action fails if a file variable source is not found. | — | true |
| strict-compatibility | Whether to fail the deployment when the Compose Specification contains features that Docker Swarm does not support and cannot be translated (e.g. develop, profiles, provider). When false (the default), such features are stripped or translated with a warning instead of failing. | — | false |
| key-interpolation | Whether to enable interpolation of environment variables within keys in the Compose Specification, in addition to values. This is not supported by the Compose Spec, and thus needs to be enabled explicitly. | — | false |
| monitor | Whether to monitor the stack after the deployment is complete. If an error occurs, the action will fail. | — | false |
| monitor-timeout | Timeout for post-deployment monitoring in seconds. | — | 300 |
| monitor-interval | Interval for post-deployment monitoring checks in seconds. | — | 5 |
| health-check-warnings | Whether to emit warnings for missing or suspect health check configurations in compose services. | — | true |