Refactor overall docker workflow when dealing with environment and config files, pass '--delete' flag to rsync during VPS deployment

Author: Mega-JC

.github/workflows/deploy-to-vps.yml

@@ -17,14 +17,25 @@ jobs:
         uses: easingthemes/ssh-deploy@main
         with:
           SSH_PRIVATE_KEY: ${{ secrets.VPS_SSH_PRIVATE_KEY }}
+          ARGS: "-rlgoDzvc --delete -i"
           REMOTE_HOST: ${{ secrets.VPS_HOST }}
           REMOTE_USER: ${{ secrets.VPS_USER }}
+          TARGET: ${{ secrets.VPS_TARGET }}
           SCRIPT_AFTER: |
-            cp ~/config.py config.py
-            cp ~/.env .env
-            docker compose stop
-            docker compose rm -f
+            # Check if a directory for environment and config files is specified and copy its contents to the current directory if yes             
+            if [ -n "${{ secrets.VPS_ENV_DIRECTORY }}" ] && [ -d "${{ secrets.VPS_ENV_DIRECTORY }}" ]; then cp -ar "${{ secrets.VPS_ENV_DIRECTORY }}"/. .; fi
+            
+            # Detect all usable Compose files ([docker-]compose.yml and [docker-]compose.override.yml) and prefix their filename with "-f "
+
+            COMPOSE=$( [ -f "docker-compose.yml" ] && echo -n "-f docker-compose.yml " || true; \
+            [ -f "docker-compose.override.yml" ] && echo -n "-f docker-compose.override.yml " || true; \
+            [ -f "compose.yml" ] && echo -n "-f compose.yml " || true; \
+            [ -f "compose.override.yml" ] && echo -n "-f compose.override.yml " || true )
+            
+            # Stop, remove, and build the Docker Compose stack
+            docker compose $COMPOSE stop
+            docker compose $COMPOSE rm
             sleep 60
-            docker compose build --no-cache
-            docker compose up -d
+            docker compose $COMPOSE build --no-cache
+            docker compose $COMPOSE up -d
             docker image prune -af

Dockerfile

@@ -35,12 +35,8 @@ COPY ./docker-entrypoint.sh /docker-entrypoint.sh
 RUN chmod +x /docker-entrypoint.sh
 
 COPY ./pcbot /app/pcbot
-RUN mkdir /app/logs
-COPY ./config.p* /app/config.py
-COPY ./localconfig.p* /app/localconfig.py
-COPY ./.env /app/.env
 
 WORKDIR /app
 
 ENTRYPOINT /docker-entrypoint.sh $0 $@
-CMD [ "python3", "-m", "pcbot.__main__"]
+CMD [ "python3", "-m", "pcbot.__main__", "--config", "env/config.py", "--localconfig", "env/localconfig.py"]

docker-compose-dev.yml.example

@@ -1,11 +1,14 @@
 services:
-  PygameCommunityBot-Dev:
-    image: PygameCommunityBot-Dev:latest
+  pygamecommunitybot-dev:
+    image: pygamecommunitybot-dev:latest
     restart: unless-stopped
     build:
       context: .
       dockerfile: Dockerfile
     tty: true
     # Add helpful development volumes here
-    # volumes:
-      # - ...:...
+    volumes:
+      # Mount environment and config files directory
+      # to the service as a volume
+      - ${ENV_VOLUME}:/app/env/
+

docker-compose.yml

@@ -1,10 +1,14 @@
+# This is a sample configuration file for a production environment. Use production override files for customization.
+
 services:
   pygamecommunitybot:
     image: pygamecommunitybot:latest
     restart: unless-stopped
     build:
       context: .
       dockerfile: Dockerfile
-    tty: true
     volumes:
-      - /mnt/blockstorage:/mnt/blockstorage
+      # Mount environment and config files directory
+      # to the service as a volume
+      - ${ENV_VOLUME}:/app/env/
+    tty: true