Saltar al contenido principal

REQ-AVA-03 — Control de versiones y despliegues

· 4 min de lectura
Yovany Suárez Silva
Software Engineer - FullStack Developer

Cierra el requerimiento REQ-AVA-03 (Disponibilidad, prioridad Media). El sistema ya usaba Git, pero el despliegue no estaba controlado por el control de versiones: se copiaba con scp una carpeta dist/ construida en un equipo de desarrollo, no había etiquetas ni integración continua para el API y la web, y el esquema de la base de datos y el árbol de dependencias vivían fuera de Git. Dos despliegues de la «misma» revisión podían acabar en bases distintas.


📋 Alcance​

Criterio de aceptaciónEntregable
Se utiliza control de versionesEl esquema (migraciones SQL y TypeORM), el lockfile, los flujos de CI y los guiones de despliegue pasan a estar versionados
Los despliegues están controlados mediante el control de versionesdeploy/desplegar.sh <tag|commit> despliega una revisión exacta, con tres comprobaciones que fallan antes de tocar el servicio

🎯 Qué cambió​

1. El despliegue es una revisión de Git, no una carpeta​

cd /var/www/ccf-almacen/api
./deploy/desplegar.sh v1.0.0 # tag o commit
./deploy/desplegar.sh v0.9.0 # revertir = desplegar el tag anterior

El guion trae las revisiones, exige que el commit esté en una rama de origin, comprueba que el árbol esté limpio, hace git checkout de ese commit, instala con npm ci, compila, aplica las migraciones versionadas y recarga PM2. Si algo no se puede comparar con Git, falla antes de desplegar.

2. El sistema dice qué revisión está corriendo​

deploy/generar-version.js corre como prebuild y sella la compilación con el commit real:

DóndeQué
GET /version (API)El sello completo
GET /health (API)version, commit, rama y origen
GET /version.json (web y wiki)El sello publicado
Pie de página del panel© 2026 - CCF Almacén · v1.0.0 (9f1c2ab)

Si el commit no se puede resolver, el sello queda como desconocido y sucio: true: no se declara limpio lo que no se puede probar.

3. Estándar arreglado por el camino​

HallazgoCorrección
database/, src/database en .gitignoreEl esquema ahora se versiona (los volcados de datos siguen fuera)
package-lock.json en .gitignore en los cuatro proyectosSe versiona: npm ci instala exactamente lo que se probó. El flujo de GitHub Pages de la wiki usaba npm ci sin lockfile versionado: no podía instalar dependencias
.github/ en .gitignore en API, web y móvilLa CI se versiona (en el móvil ya existía un ci.yml que no estaba confirmado)
src/components/__tests__/ y e2e/ en .gitignore (web)La suite que valida cada entrega pasa a formar parte de la revisión
/backups con las claves de cifradoSe mantiene fuera del control de versiones, a propósito

⚙️ Integración continua y liberaciones​

FlujoSe dispara conQué hace
ci.yml (API y web)push / PR a mainCompila, comprueba que el sello es el commit que GitHub construye y ejecuta las pruebas
release.yml (API y web)push de un tag v*Compila la etiqueta, verifica el sello, prueba y publica la liberación con el sello adjunto
deploy.yml (wiki)push a mainPublica el sitio en GitHub Pages

🧪 Pruebas​

  • ccf-almacen-api/src/common/version/req-ava-03-version.spec.ts — 12 casos.
  • ccf-almacen-web/src/utils/version-despliegue.spec.ts — 7 casos.
  • Suite del API: 118 suites y 1137 pruebas en verde.
  • Corrección incidental: req-sec-12-validacion.spec.ts importaba dos DTO con una ruta relativa de un nivel de menos y la suite no compilaba.

Deuda que quedó a la vista (no se tocó)​

Al versionar la suite del panel web aparecieron 3 suites y 11 pruebas que ya fallaban: sesiones.test.tsx, login-2fa.test.tsx y sesion-aviso.test.tsx (sesiones y segundo factor). Son ajenas a este requerimiento y requieren revisar cómo simulan el estado de autenticación. Por eso en la CI de la web solo es bloqueante la prueba de REQ-AVA-03 y el resto se informa sin bloquear. El resto de la suite (30 suites, 202 pruebas) está en verde.

⏳ Pendiente (operativo, no de código)​

  1. Confirmar el trabajo pendiente y etiquetar v1.0.0 en los cuatro repositorios. Mientras el árbol tenga cambios sin confirmar, deploy/desplegar.sh fallará a propósito.
  2. Clonar el repositorio en el servidor en lugar de copiar dist/.
  3. Unificar el propietario del remoto (la API está en CCF-Maya; el resto en CDS-Maya).
  4. Validar las GitHub Actions al empujarlas: solo se ejecutan en GitHub.

📚 Documentación​