ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend

Fail CI if Alembic autogenerate detects schema drift

Abierto
#287 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement
Lenguaje dominante
Python
Estrellas
18
Forks
10
Merge medio
2 d 20 h
PR fusionados (30 d)
14

Descripción

Description
At present, we don’t have an automated way to ensure that our SQLModel data models and the database schema are in sync. The only way to check is manually, typically by running the alembic revision command. However, this step can easily be overlooked by someone pushing code, which can lead to inconsistencies accumulating over time. To automate this verification, we should add a CI step that runs:

alembic revision --autogenerate -m "ci check"

and then verifies that the generated migration file is empty (i.e., it contains no upgrade()/downgrade() operations).

If alembic generates non-empty changes, the CI job should fail, signalling a mismatch between the current database schema and our models.

Acceptance Criteria

  • Add a step in GitHub Actions workflow to run alembic revision --autogenerate against the test database.

  • Fail the job if the generated migration contains actual schema changes.

  • Clean up the generated revision file after the check.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Localiza el workflow de GitHub Actions y la configuración existente de la base de datos de pruebas; después, revisa la configuración de Alembic utilizada por el proyecto. Ejecuta el comando autogenerate especificado contra esa base de datos y determina cómo detectar operaciones upgrade()/downgrade() no vacías. Se considera completado cuando el workflow falla ante una divergencia del esquema y elimina después la revisión generada.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
github-actions, python
Área
ci-cd, database
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
52/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.