Add github actions workflow for basic deployments

Author: bcb

docs/advanced.md

@@ -256,7 +256,11 @@ docker compose exec caddy caddy reload --config /etc/caddy/Caddyfile
 
 ## ⚡ GitHub Actions
 
-Here's a Github Actions workflow you can use to automate deployments:
+Here's a Github Actions workflow you can use to automate deployments.
+
+```sh
+mkdir -p .github/workflows
+```
 
 <details>
 <summary>Show full workflow</summary>
@@ -306,7 +310,7 @@ jobs:
 
             # Bring up stack and run healthchecks
             trap 'docker compose down' ERR
-            docker compose up --detach
+            docker compose up -d
             docker compose exec -T caddy curl -fsS http://caddy:80/healthz
             # Add more healthchecks here
             # docker compose exec -T caddy curl -fsS http://api:8080/healthz

docs/deploy.md

@@ -24,15 +24,14 @@ Build and push your images:
 cd app
 docker compose build
 docker compose push
-cd ..
 ```
 
 ## 📦 2. Copy to Server
 
 Copy your `compose.yaml` to the remote host:
 
 ```sh
-scp app/compose.yaml youruser@yourserver:
+scp compose.yaml youruser@yourserver:
 ```
 
 ## 3. Set Secrets
@@ -59,7 +58,7 @@ Your backend is now live. 🚀
 
 ## Upgrading
 
-To upgrade your app, simply increment the image tag versions in compose.yaml.
+To upgrade your app, simply increment the image tag versions in `compose.yaml`.
 
 The rest is the same:
 
@@ -72,3 +71,67 @@ The rest is the same:
 
 If you want zero-downtime deployments, rollback support, or blue-green testing,
 continue to [Advanced Deployments](advanced.md).
+
+## ⚡ GitHub Actions
+
+Here's a Github Actions workflow you can use to automate deployments.
+
+```sh
+mkdir -p .github/workflows
+```
+
+<details>
+<summary>Show full workflow</summary>
+
+```yaml title=".github/workflows/ci.yaml"
+name: Deploy
+
+on:
+  push:
+    branches:
+      - prod
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Copy compose.yaml from repository to deployment dir
+        uses: appleboy/scp-action@master
+        with:
+          host: ${{ secrets.VPS_HOST }}
+          username: ${{ secrets.VPS_USER }}
+          key: ${{ secrets.VPS_SSH_KEY }}
+          source: "app/compose.yaml"
+          target: "app/"
+
+      - name: Deploy with Docker Compose
+        uses: appleboy/[email protected]
+        env:
+          GHCR_PAT: ${{ secrets.GHCR_PAT }}
+        with:
+          host: ${{ secrets.VPS_HOST }}
+          username: ${{ secrets.VPS_USER }}
+          key: ${{ secrets.VPS_SSH_KEY }}
+          envs: GHCR_PAT
+          script: |
+            set -euo pipefail
+            cp .env app/
+            cd app
+
+            # Pull images
+            echo "$GHCR_PAT" | docker login ghcr.io --username "${{ github.actor }}" --password-stdin
+            DOCKER_CLIENT_TIMEOUT=300 COMPOSE_HTTP_TIMEOUT=300 docker compose pull --quiet
+
+            # Bring up stack and run healthchecks
+            trap 'docker compose down' ERR
+            docker compose up -d
+            docker compose exec -T caddy curl -fsS http://caddy:80/healthz
+            # Add more healthchecks here
+            # docker compose exec -T caddy curl -fsS http://api:8080/healthz
+            # docker compose exec -T caddy curl -fsS http://postgrest:3000/
+```
+
+</details>