This actions deploys your docker-compose stack file to remote host where docker-compose does not even have to be installed.

Remote host where docker is running

SSH port on remote host

SSH user on remote host

SSH private key used to access to remote server. Better save it into repository secrets.

Optional. Docker compose filename. Default: docker-compose.yml

Optional. Name of service to be deployed. By default all services are deployed.

Optional. Recreate containers even if compose file did not change. Default: false

Optional. Pull docker images before deploying. Default: false

Optional. Build docker images before deploying. Default: false

Optional. Pass additional options to docker-compose. For example: --no-deps

steps:
  # need checkout before using docker-compose-remote-action
  - uses: actions/checkout@v2
  - uses: chaplyk/[email protected]
    with:
      ssh_host: 127.0.0.1
      ssh_user: username
      ssh_key: ${{ secrets.SSH_KEY }}
      compose_file: docker-compose.yml
      pull: true
      build: true