alcharra/Docker Deploy Action (Go)

Uploads Docker Compose/Stack files and deploys via SSH using a Go-based binary

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
ssh_host	The hostname or IP address of the remote server you're deploying to.	yes	—
ssh_port	The port used to connect via SSH.	no	22
ssh_user	The SSH username used to connect to the server.	yes	—
ssh_key	Your private SSH key for authenticating with the server.	yes	—
ssh_key_passphrase	(If applicable) The passphrase used to unlock the SSH key.	no	—
ssh_known_hosts	The contents of your `known_hosts` file, used to verify the server's identity.	no	—
ssh_fingerprint	The server's SSH fingerprint in SHA256 format (alternative to `known_hosts`).	no	—
ssh_timeout	SSH connection timeout duration (e.g. `10s`, `30s`, `1m`).	no	10s
project_path	The full path on the server where files will be uploaded and deployed.	yes	—
deploy_file	The name of your main deployment file (e.g. `docker-compose.yml` or `docker-stack.yml`).	yes	docker-compose.yml
extra_files	A list of extra files or folders to upload. Use a multi-line format — one path per line.	no	—
mode	Deployment method: either `compose` or `stack`.	no	compose
stack_name	Name of the Docker stack (required if using `stack` mode).	no	—
compose_pull	Pull the latest images before starting services (`true` or `false`).	no	true
compose_build	Build images before starting services (`true` or `false`).	no	false
compose_no_deps	Skip starting linked services (`true` or `false`).	no	false
compose_target_services	A list of specific services to restart. Use a multi-line format — one service per line.	no	—
docker_network	The name of the Docker network to use or create if missing.	no	—
docker_network_driver	The network driver to use (`bridge`, `overlay`, etc.).	no	bridge
docker_network_attachable	Allow standalone containers to attach to the network (`true` or `false`).	no	false
docker_prune	Type of Docker clean-up to run after deployment (e.g. `system`, `volumes`, `none`).	no	none
registry_host	The container registry hostname (e.g. `ghcr.io`) if login is required.	no	—
registry_user	Username for the registry.	no	—
registry_pass	Password or token for the registry.	no	—
enable_rollback	Automatically roll back if deployment fails (`true` or `false`).	no	false
env_vars	Environment variables to include in a `.env` file uploaded to the server.	no	—
verbose	Show extra internal command details and debug output (`true` or `false`).	no	false

Outputs

no outputs