infra(develop): creates CI/CD pipeline for staging environment

- Adds a GitHub Actions workflow to automate the deployment of the staging environment whenever changes are pushed to the develop branch.
- Updates the Makefile to include commands for deploying to staging.
- Creates a new Docker Compose file for the staging environment and modifies the existing one to accommodate the new setup.

Author: pedro-fs-garcia

.github/workflows/deploy-staging.yaml

@@ -0,0 +1,65 @@
+name: Deploy Staging
+on:
+  push:
+    branches: [ "develop" ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository_owner }}/syncdesk-api
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: deploy/Dockerfile
+          push: true
+          tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:staging
+
+  deploy:
+    needs: build-and-push
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Copy compose files to Droplet
+        uses: appleboy/scp-action@v0.1.7
+        with:
+          host: ${{ secrets.DROPLET_HOST }}
+          username: ${{ secrets.SSH_USERNAME }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          target: /opt/syncdesk
+          source: docker-compose.yaml,deploy/docker-compose.staging.yaml,deploy/prometheus,deploy/alertmanager,deploy/loki,deploy/promtail,deploy/grafana
+
+      - name: Deploy to Droplet
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.DROPLET_HOST }}
+          username: ${{ secrets.SSH_USERNAME }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          script: |
+            cd /opt/syncdesk
+            docker compose -f docker-compose.yaml -f deploy/docker-compose.staging.yaml pull api
+            docker compose -f docker-compose.yaml -f deploy/docker-compose.staging.yaml up -d --force-recreate

Makefile

@@ -1,4 +1,5 @@
-.PHONY: install run dev lint format typecheck test seed migrate makemigration pre-commit
+.PHONY: install run dev lint format typecheck test seed migrate makemigration pre-commit up down logs
+
 
 install:
 	poetry install
@@ -41,3 +42,12 @@ pre-commit:
 	poetry run mypy app/
 	poetry run bandit -c pyproject.toml -r app/
 	poetry run pytest
+
+up:
+	docker compose up --build
+
+down:
+	docker compose down
+
+logs:
+	docker compose logs -f

deploy/docker-compose.staging.yaml

@@ -0,0 +1,3 @@
+services:
+  api:
+    image: ghcr.io/titus-system/syncdesk-api:staging

docker-compose.override.yaml

@@ -0,0 +1,9 @@
+services:
+  api:
+    build:
+      context: .
+      dockerfile: deploy/Dockerfile
+    volumes:
+      - .:/app
+    environment:
+      UVICORN_RELOAD: "true"

docker-compose.yaml

@@ -41,21 +41,15 @@ services:
       start_period: 10s
 
   api:
-    build:
-      context: .
-      dockerfile: deploy/Dockerfile
     container_name: syncdesk_api
     restart: unless-stopped
     env_file:
       - .env
     environment:
       POSTGRES_HOST: db
       MONGO_HOST: mongo
-      UVICORN_RELOAD: "true"
     ports:
       - "8000:8000"
-    volumes:
-      - .:/app
     depends_on:
       db:
         condition: service_healthy