chore: update the docker-compose pipeline

Author: joepreludian

.github/workflows/ci-cd.yml

@@ -81,7 +81,7 @@ jobs:
         run: |
           docker compose up -d sdci-server
           sleep 5
-          docker compose run sdci-client
+          docker compose run --rm sdci-client
           curl -s -o /dev/null -w "%{http_code}" http://localhost:8842/docs || true
           docker compose down
 

Dockerfile

@@ -17,7 +17,7 @@ RUN apt-get update && \
     $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
     tee /etc/apt/sources.list.d/docker.list > /dev/null \
     && apt-get update \
-    && apt-get install -y docker-ce-cli
+    && apt-get install -y docker-ce-cli curl
 
 COPY ./ /app/
 

Makefile

@@ -12,3 +12,10 @@ build: clean
 
 publish: build
 	uv publish
+
+docker-build: build
+	docker compose build sdci-base
+
+docker-testing: docker-build
+	docker compose run --rm sdci-client
+	docker compose down

README.md

@@ -11,6 +11,7 @@ SDCI (Sistema de Deploy Continuo Integrado - Integrated Continuous Deployment Sy
 - Token-based authentication
 - Real-time task output streaming
 - Task status monitoring
+- CLI interface to manage tasks
 
 ## 🔩 Architecture Diagram
 The ideal way to work with this tool is using the following structure:
@@ -43,6 +44,9 @@ python -m src.server
 
 By default, the server runs on `0.0.0.0:8842`.
 
+## Creating tasks
+The server will look up for tasks in the `tasks/` directory where you ran this server. It will look for shell scripts on this folder. The job name is the script name without the `.sh` extension.
+
 ### Using the client
 
 The client tool can be used to trigger tasks on the server:

docker-compose.yaml

@@ -13,6 +13,12 @@ services:
       - "8842:8842"
     environment:
       - SDCI_SERVER_TOKEN=HELLO_WORLD_123
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8842/health"]
+      interval: 3s
+      timeout: 3s
+      retries: 4
+      start_period: 1s
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
       - ./src/tasks:/app/src/tasks
@@ -25,5 +31,8 @@ services:
       - SDCI_TOKEN=HELLO_WORLD_123
     profiles:
       - client-run
+    depends_on:
+      sdci-server:
+        condition: service_healthy
     volumes:
       - ./:/app/

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sdci"
-version = "0.6.1"
+version = "0.6.2"
 description = "SDCI - Sistema de Deploy Continuo Integrado - Integrated Continuous Deployment System - Sidecar Micro CD"
 readme = "README.md"
 authors = [

src/sdci/server.py

@@ -58,6 +58,11 @@ async def verify_token(token: str = Depends(oauth2_scheme)):
     return token
 
 
+@app.get("/health")
+async def health():
+    return {"status": "OK"}
+
+
 @app.post("/tasks/{task_name:str}/", dependencies=[Depends(verify_token)])
 async def run_task(task_name: str, request: TaskRequestSchema):
     global task_info_store