ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
Fail CI if Alembic autogenerate detects schema drift
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 18
- Fork
- 10
- Merge medio
- 2g 20h
- PR unite (30g)
- 14
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Individua il workflow di GitHub Actions e la configurazione esistente del database di test, quindi esamina la configurazione Alembic utilizzata dal progetto. Esegui il comando autogenerate specificato su quel database e determina come rilevare operazioni upgrade()/downgrade() non vuote. Il lavoro è completato quando il workflow fallisce in presenza di una deriva dello schema e rimuove successivamente la revisione generata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github-actions, python
- Ambito
- ci-cd, database
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 52/100