feature/testing #3

Merged
sancho41 merged 5 commits from feature/testing into develop 2026-03-27 16:22:43 -03:00
5 changed files with 41 additions and 19 deletions
Showing only changes of commit 3f0bb4be73 - Show all commits

View File

@@ -33,5 +33,5 @@ LLAMA_MODEL=gemma3:4b
# ── Application ─────────────────────────────────────────────────────────────── # ── Application ───────────────────────────────────────────────────────────────
APP_RECIPIENTS=friend1@example.com,friend2@example.com APP_RECIPIENTS=friend1@example.com,friend2@example.com
# ── Frontend (Vite build-time) ──────────────────────────────────────────────── # ── Frontend (Vite dev proxy) ────────────────────────────────────────────────
VITE_API_BASE_URL=http://localhost VITE_API_BASE_URL=http://localhost

View File

@@ -0,0 +1,25 @@
name: Build Production Images
on:
pull_request_review:
types: [submitted]
jobs:
build:
name: Build Production Images
if: github.event.review.state == 'approved' && github.event.pull_request.base.ref == 'main'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
github-server-url: http://gitea.lab
ref: ${{ github.event.pull_request.head.sha }}
- name: Verify Docker CLI
run: docker version
- name: Build backend image
run: docker build -t condado-newsletter-backend:latest -f backend/Dockerfile ./backend
- name: Build frontend image
run: docker build -t condado-newsletter-frontend:latest -f frontend/Dockerfile ./frontend

View File

@@ -1,6 +1,6 @@
--- ---
name: infra name: infra
description: "Use when working on Docker configuration, Docker Compose files, Dockerfiles, Nginx config, Supervisor config, Gitea Actions workflows, CI/CD pipelines, environment variables, or overall project architecture in the condado-news-letter project. Trigger phrases: docker, dockerfile, compose, nginx, ci/cd, gitea actions, build fails, infra, architecture, environment variables, container, supervisor, allinone image." description: "Use when working on Docker configuration, Docker Compose files, Dockerfiles, Nginx config, Supervisor config, Gitea Actions workflows, CI/CD pipelines, deploy flows, environment variables, or overall project architecture in the condado-news-letter project. Trigger phrases: docker, dockerfile, compose, nginx, ci/cd, gitea actions, deploy, build fails, infra, architecture, environment variables, container, supervisor, allinone image."
tools: [read, edit, search, execute, todo] tools: [read, edit, search, execute, todo]
argument-hint: "Describe the infrastructure change or Docker/CI task to implement." argument-hint: "Describe the infrastructure change or Docker/CI task to implement."
--- ---
@@ -22,6 +22,7 @@ You are a senior DevOps / infrastructure engineer and software architect for the
| `docker/supervisord.conf` | Supervisor config (manages postgres + java + nginx inside allinone) | | `docker/supervisord.conf` | Supervisor config (manages postgres + java + nginx inside allinone) |
| `docker/entrypoint.sh` | Allinone container entrypoint (DB init, env wiring, supervisord start) | | `docker/entrypoint.sh` | Allinone container entrypoint (DB init, env wiring, supervisord start) |
| `.gitea/workflows/ci.yml` | CI: backend tests + frontend tests on pull requests to `develop` | | `.gitea/workflows/ci.yml` | CI: backend tests + frontend tests on pull requests to `develop` |
| `.gitea/workflows/build.yml` | Build: create local backend/frontend images on approved PRs to `main` |
| `.env.example` | Template for all environment variables | | `.env.example` | Template for all environment variables |
## System Topology ## System Topology
@@ -53,7 +54,7 @@ Docker volume → /var/lib/postgresql/data
| Flavour | Command | Notes | | Flavour | Command | Notes |
|---|---|---| |---|---|---|
| Dev | `docker compose up --build` | Includes Mailhog on :1025/:8025 | | Dev | `docker compose up --build` | Includes Mailhog on :1025/:8025 |
| Prod (compose) | `docker compose -f docker-compose.prod.yml up --build` | External DB/SMTP | | Prod (compose) | `docker compose -f docker-compose.prod.yml up -d` | External DB/SMTP using prebuilt local images |
| All-in-one | `docker run -p 80:80 -e APP_PASSWORD=... <image>` | Everything in one container | | All-in-one | `docker run -p 80:80 -e APP_PASSWORD=... <image>` | Everything in one container |
## Key Environment Variables ## Key Environment Variables
@@ -73,15 +74,16 @@ All injected at runtime — never hardcoded in images.
| `IMAP_HOST` / `IMAP_PORT` / `IMAP_INBOX_FOLDER` | Backend | IMAP server | | `IMAP_HOST` / `IMAP_PORT` / `IMAP_INBOX_FOLDER` | Backend | IMAP server |
| `OPENAI_API_KEY` / `OPENAI_MODEL` | Backend | OpenAI credentials | | `OPENAI_API_KEY` / `OPENAI_MODEL` | Backend | OpenAI credentials |
| `APP_RECIPIENTS` | Backend | Comma-separated recipient emails | | `APP_RECIPIENTS` | Backend | Comma-separated recipient emails |
| `VITE_API_BASE_URL` | Frontend (build-time ARG) | Backend API base URL | | `VITE_API_BASE_URL` | Frontend dev server | Backend API base URL for Vite proxy |
## CI/CD Pipeline ## CI/CD Pipeline
| Workflow | Trigger | What it does | | Workflow | Trigger | What it does |
|---|---|---| |---|---|---|
| `ci.yml` | Pull request to `develop` | Backend `./gradlew test` + Frontend `npm run test` | | `ci.yml` | Pull request to `develop` | Backend `./gradlew test` + Frontend `npm run test` |
| `build.yml` | Approved PR review to `main` | Builds `condado-newsletter-backend` and `condado-newsletter-frontend` on the target Docker host |
Legacy publish/version workflows were removed from in-repo automation. The runner shares the target Docker host, so this workflow produces local images directly on that host. `docker-compose.prod.yml` must reference images and not local build directives.
## Implementation Rules ## Implementation Rules

View File

@@ -83,8 +83,8 @@ The cycle for every step is:
| Reverse Proxy | Nginx (serves frontend + proxies `/api` to backend) | | Reverse Proxy | Nginx (serves frontend + proxies `/api` to backend) |
| Dev Mail | Mailhog (SMTP trap + web UI) | | Dev Mail | Mailhog (SMTP trap + web UI) |
| All-in-one image | Single Docker image: Nginx + Spring Boot + PostgreSQL + Supervisor | | All-in-one image | Single Docker image: Nginx + Spring Boot + PostgreSQL + Supervisor |
| Image registry | Not configured (legacy Docker Hub publish workflow removed) | | Image registry | Local Docker images on the deployment host (`condado-newsletter-backend`, `condado-newsletter-frontend`) |
| CI/CD | Gitea Actions — run backend/frontend tests on pull requests to `develop` | | CI/CD | Gitea Actions — test PRs to `develop`, deploy approved PRs targeting `main` |
## Deployment Flavours ## Deployment Flavours
@@ -93,7 +93,7 @@ There are **three ways to run the project**:
| Flavour | Command | When to use | | Flavour | Command | When to use |
|---------------------|---------------------------------|------------------------------------------------| |---------------------|---------------------------------|------------------------------------------------|
| **Dev** | `docker compose up` | Local development — includes Mailhog | | **Dev** | `docker compose up` | Local development — includes Mailhog |
| **Prod (compose)** | `docker compose -f docker-compose.prod.yml up` | Production with external DB/SMTP | | **Prod (compose)** | `docker compose -f docker-compose.prod.yml up -d` | Production with prebuilt backend/frontend images |
| **All-in-one** | `docker run ...` | Simplest deploy — everything in one container | | **All-in-one** | `docker run ...` | Simplest deploy — everything in one container |
### All-in-one Image ### All-in-one Image
@@ -312,7 +312,7 @@ npm run test
docker compose up --build docker compose up --build
# Prod # Prod
docker compose -f docker-compose.prod.yml up --build docker compose -f docker-compose.prod.yml up -d
# Stop # Stop
docker compose down docker compose down
@@ -456,7 +456,7 @@ Never hardcode any of these values.
| `OPENAI_API_KEY` | Backend | OpenAI API key | | `OPENAI_API_KEY` | Backend | OpenAI API key |
| `OPENAI_MODEL` | Backend | OpenAI model (default: `gpt-4o`) | | `OPENAI_MODEL` | Backend | OpenAI model (default: `gpt-4o`) |
| `APP_RECIPIENTS` | Backend | Comma-separated list of recipient emails | | `APP_RECIPIENTS` | Backend | Comma-separated list of recipient emails |
| `VITE_API_BASE_URL` | Frontend | Backend API base URL (used by Vite at build time) | | `VITE_API_BASE_URL` | Frontend | Backend API base URL for the Vite dev server proxy |
> ⚠️ Never hardcode credentials. Always use environment variables or a `.env` file (gitignored). > ⚠️ Never hardcode credentials. Always use environment variables or a `.env` file (gitignored).
@@ -575,8 +575,9 @@ Good examples:
| Workflow file | Trigger | What it does | | Workflow file | Trigger | What it does |
|----------------------------|----------------------------|-----------------------------------------------------------| |----------------------------|----------------------------|-----------------------------------------------------------|
| `.gitea/workflows/ci.yml` | PR to `develop` | Backend tests (`./gradlew test`) + Frontend tests (`npm run test`) | | `.gitea/workflows/ci.yml` | PR to `develop` | Backend tests (`./gradlew test`) + Frontend tests (`npm run test`) |
| `.gitea/workflows/build.yml` | Approved PR review on `main` | Build `condado-newsletter-backend` and `condado-newsletter-frontend` locally on the runner host |
Current policy: old publish/version automation workflows were removed during the Gitea migration. Build policy: the runner shares the target Docker host, so the build workflow produces local Docker images directly on that host. `docker-compose.prod.yml` is image-based and can be started separately without build directives.
--- ---

View File

@@ -20,9 +20,7 @@ services:
# ── Backend (Spring Boot) ──────────────────────────────────────────────────── # ── Backend (Spring Boot) ────────────────────────────────────────────────────
backend: backend:
build: image: condado-newsletter-backend:latest
context: ./backend
dockerfile: Dockerfile
restart: always restart: always
depends_on: depends_on:
postgres: postgres:
@@ -55,11 +53,7 @@ services:
# ── Frontend + Nginx ───────────────────────────────────────────────────────── # ── Frontend + Nginx ─────────────────────────────────────────────────────────
nginx: nginx:
build: image: condado-newsletter-frontend:latest
context: ./frontend
dockerfile: Dockerfile
args:
VITE_API_BASE_URL: ${VITE_API_BASE_URL}
restart: always restart: always
ports: ports:
- "80:80" - "80:80"