Files
docker-remote-deployment-ac…/action.yml
2024-03-07 22:49:21 +08:00

62 lines
1.8 KiB
YAML

name: Docker Remote (SSH) Deployment
description: A GitHub Action that supports docker-compose and Docker Swarm deployments
inputs:
remote_docker_host:
description: Remote Docker host.
required: true
remote_docker_user:
description: Remote Docker user.
required: true
remote_docker_port:
description: Remote Docker ssh port ie (22).
required: false
default: '22'
# ssh_public_key:
# description: Remote Docker SSH public key eg (~/.ssh/rsa_id.pub).
# required: true
ssh_private_key:
description: SSH private key used to connect to the docker host eg (~/.ssh/rsa_id).
required: true
ssh_proxy_cmd:
description: SSH ProxyCommand used to connect to the docker host.
required: false
args:
description: Deployment command args.
required: true
deploy_path:
description: The absolute path on remote docker host to deploy, default rely on repo working directory .
required: false
stack_file_name:
description: Compose configuration files.
required: false
env_file_name:
description: Specify an alternate environment file.
required: false
keep_files:
description: Number of the files to be kept on the server. Default is 3.
required: false
docker_prune:
description: A boolean input to trigger docker prune command. Default is false.
required: false
pre_deployment_command_args:
description: The args for the pre deploument command.
required: false
docker_registry_username:
description: The docker registry username.
required: false
docker_registry_password:
description: The docker registry password.
required: false
docker_registry_uri:
description: The docker registry URI. Default is https://registry.hub.docker.com.
required: false
runs:
using: docker
image: Dockerfile
branding:
icon: send
color: green