Add branch auto-deploy workflow for VPS

Author: TalehTaghi

.github/workflows/deploy.yml

@@ -0,0 +1,61 @@
+name: Deploy to VPS
+
+on:
+  push:
+    branches:
+      - web-application-version
+  workflow_dispatch:
+
+concurrency:
+  group: deploy-web-application-version
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: production
+
+    steps:
+      - name: Deploy over SSH
+        uses: appleboy/ssh-action@v1.2.0
+        env:
+          DEPLOY_BRANCH: web-application-version
+          DEPLOY_PATH: ${{ vars.DEPLOY_PATH }}
+          IMAGE_NAME: ${{ vars.IMAGE_NAME }}
+          CONTAINER_NAME: ${{ vars.CONTAINER_NAME }}
+          APP_PORT: ${{ vars.APP_PORT }}
+        with:
+          host: ${{ secrets.VPS_HOST }}
+          username: ${{ secrets.VPS_USER }}
+          key: ${{ secrets.VPS_SSH_KEY }}
+          port: ${{ secrets.VPS_PORT }}
+          script_stop: true
+          envs: DEPLOY_BRANCH,DEPLOY_PATH,IMAGE_NAME,CONTAINER_NAME,APP_PORT
+          script: |
+            set -euo pipefail
+
+            cd "$DEPLOY_PATH"
+            git fetch origin "$DEPLOY_BRANCH"
+            git checkout "$DEPLOY_BRANCH"
+            git reset --hard "origin/$DEPLOY_BRANCH"
+
+            docker build -t "$IMAGE_NAME" .
+
+            docker rm -f "${CONTAINER_NAME}_migrate" >/dev/null 2>&1 || true
+            
+            docker run --rm \
+              --name "${CONTAINER_NAME}_migrate" \
+              --env-file ~/app/.env \
+              -e RUN_MIGRATIONS=1 \
+              "$IMAGE_NAME" true
+
+            docker rm -f "$CONTAINER_NAME" >/dev/null 2>&1 || true
+
+            docker run -d \
+              --name "$CONTAINER_NAME" \
+              --restart unless-stopped \
+              --env-file ~/app/.env \
+              -p "$APP_PORT:8000" \
+              "$IMAGE_NAME"
+
+            docker image prune -f

README.md

@@ -144,3 +144,34 @@ App endpoint:
 When `RUN_MIGRATIONS=1`, set at least `DB_USER`, `DB_PASSWORD`, and `DB_NAME` (and usually `DB_HOST`/`DB_PORT`).
 For production, prefer explicit one-off migrations during deploys to avoid concurrent migration runners.
 
+---
+
+### GitHub auto-deploy to VPS
+
+A workflow is available at `.github/workflows/deploy.yml`.
+It deploys automatically on every push to `web-application-version` (including merges into that branch), and can also be started manually from Actions (`workflow_dispatch`).
+
+Required GitHub **Secrets**:
+
+- `VPS_HOST`
+- `VPS_PORT`
+- `VPS_USER`
+- `VPS_SSH_KEY` (private key content)
+
+Required GitHub **Variables**:
+
+- `DEPLOY_PATH` (absolute path of repo on VPS, e.g. `/opt/ongoing-bps-state`)
+- `IMAGE_NAME` (e.g. `ongoing-bps-state:prod`)
+- `CONTAINER_NAME` (e.g. `ongoing-bps-state`)
+- `APP_PORT` (e.g. `8000`)
+
+What the pipeline does on VPS:
+
+1. Pulls the latest code of `web-application-version`.
+2. Builds the Docker image.
+3. Runs migrations by starting a short-lived container with `RUN_MIGRATIONS=1`.
+4. Replaces the running app container with the new image.
+
+VPS requirement:
+
+- `~/app/.env` must exist on the server and include DB settings (`DB_USER`, `DB_PASSWORD`, `DB_HOST`, `DB_PORT`, `DB_NAME`).