ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
Fail CI if Alembic autogenerate detects schema drift
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 18
- Forks
- 10
- Ø Merge
- 2 T. 20 Std.
- Gemergte PRs (30 T.)
- 14
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Finde den GitHub-Actions-Workflow und die vorhandene Einrichtung der Testdatenbank, und prüfe anschließend die vom Projekt verwendete Alembic-Konfiguration. Führe den angegebenen autogenerate-Befehl für diese Datenbank aus und ermittle, wie sich nicht leere upgrade()/downgrade()-Operationen erkennen lassen. Als erledigt gilt die Aufgabe, wenn der Workflow bei Schemaabweichungen fehlschlägt und die generierte Revision anschließend entfernt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- github-actions, python
- Bereich
- ci-cd, database
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 52/100