You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Docker-Compose gitops action
v1
A GitHub Action making GitOps with the simplicity of docker-compose possible, using SSH or optionally Tailscale SSH, with support for docker swarm, uploading directory for bind mounts and other features!
The Action is adapted from work by TapTap21 and wshihadeh
Below is an example of how the action can be used
- name: Start Deployment
uses: aosus/docker-compose-gitops-action@v1
with:
remote_docker_host: [email protected]
tailscale_ssh: true # no need for manual private and public keys
compose_file_path: postgres/docker-compose.yml
upload_directory: true # upload docker directory
docker_compose_directory: postgres # directory to upload
docker_login_password: ${{ secrets.DOCKER_REPO_PASSWORD }}
docker_login_user: ${{ secrets.DOCKER_REPO_USERNAME }}
docker_login_registry : ${{ steps.login-ecr.outputs.registry }}
args: -p postgres up -d
Use the latest tag to run the latest build or a specific version tag. The action pulls a docker image instead of building one to improve performance.
args
- Docker compose/stack command arguments. Example:-p app_stack_name -d up
requiredremote_docker_host
Specify Remote Docker host. The input value must be in the following format (user@host) requiredtailscale_ssh
Enables Tailscale ssh mode, which uses managed ssh keys from Tailscale, and skips the private and public keys. default: falsessh_public_key
Remote Docker SSH public key. Required when Tailscale ssh isn't enabledssh_private_key
SSH private key used in PEM format to connect to the docker host. Required when Tailscale ssh isn't enabledssh_port
The SSH port to be used. Default is 22.compose_file_path
Docker compose file path. Default isdocker-compose.yml
(repo root), sub-directory Example:caddy/docker-compose.yml
upload_directory
Uploads docker compose directory, useful for extra files like Configs. Optionaldocker_compose_directory
Specifies which directory in the repository to upload, needed for upload_directorypost_upload_command
Optional input to execute a command post upload, whenupload_directory
is enabled. Useful for things like changing permissions before starting containers.docker_swarm
Uses docker swarm instead of compose by using the docker stack command, default: falsedocker_login_user
The username for the container repository user. (DockerHub, ECR, etc.). Optional.docker_login_password
The password for the container repository user.docker_login_registry
The docker container registry to authenticate against Optional
This project is licensed under the MIT license. See the LICENSE file for details.