tristiisch/Docker Stack Deployment
A GitHub Action that supports docker-compose and Docker Swarm deployments
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| remote_docker_host | Remote Docker host (e.g., 127.0.0.1) | yes | — |
| remote_docker_port | Remote Docker SSH port (default: 22) | — | 22 |
| remote_docker_username | Remote Docker username (e.g., baptiste) | yes | — |
| ssh_public_key | Public key of the SSH server | — | — |
| ssh_private_key | Private key of the SSH client | yes | — |
| deployment_mode | Deployment mode: docker-swarm or docker-compose (default: docker-compose) | — | docker-compose |
| copy_stack_file | Copy stack file to remote server and deploy from the server (default: false) | — | — |
| deploy_path | Path where stack files will be copied (default: ~/docker-deployment) | — | — |
| stack_file_path | Path to Docker stack file (default: docker-compose.yaml) | — | — |
| keep_files | Number of files to keep on the server (default: 3) | — | 3 |
| docker_prune | Trigger docker prune command (default: false) | — | false |
| docker_remove_orphans | Remove containers for services not defined in the Compose file (default: true) | — | true |
| pre_deployment_command_args | [Docker Compose] Arguments for the pre-deployment command | — | — |
| pull_images_first | [Docker Compose] Pull Docker images before deploying | — | — |
| stack_name | [Docker Swarm] Specify the name of your Docker Swarm stack. | — | — |
| deploy_foreground | [Docker Swarm] Waiting for the stack to complete the rolling update. | — | true |
| secrets | Update Docker Secret using rotation during stack update. The format is: service_name secret_name key1 value1 key2 value2 ... | — | — |
| secrets_delete_old | Remove any replaced secrets during stack update (default: true). | — | true |
| secrets_prune | Remove all unused Docker secrets (default: false). | — | false |
| args | Command arguments for deployment | — | — |
| debug | Include additional debugging information in the logs (default: false) | — | false |
| trace | Log every execution step for detailed tracing (default: false) | — | false |
Outputs
no outputs