ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
Fail CI if Alembic autogenerate detects schema drift
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 18
- Fork
- 10
- Merge trung bình
- 2 ngày 20 giờ
- Pull request đã merge (30 ngày)
- 14
Mô tả
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.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Tìm workflow GitHub Actions và thiết lập cơ sở dữ liệu kiểm thử hiện có, sau đó xem xét cấu hình Alembic được dự án sử dụng. Chạy lệnh autogenerate được chỉ định trên cơ sở dữ liệu đó và xác định cách phát hiện các thao tác upgrade()/downgrade() không rỗng. Hoàn thành khi workflow thất bại do schema drift và xóa revision đã tạo sau đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions, python
- Lĩnh vực
- ci-cd, database
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 52/100