Tips and Tricks for Alembic Versioning - Githubissues

cds-snc / notification-planning-core

Project planning for GC Notify Core Team

0 stars 0 forks source link

Tips and Tricks for Alembic Versioning #362

Open P0NDER0SA opened 1 month ago

P0NDER0SA commented 1 month ago

Description

As a developer I would like to be able to understand how to upgrade and rollback individual Alembic migrations against any notify database.

WHY are we building? We are building to enhance our knowledge and ability fix migrations more fluently and with more understandable outcomes

WHAT are we building? Tips and Tricks to explain how to manage these processes

VALUE created by our solution faster and more effective maintenance of database migration scripts

Documentation and Artifacts

https://docs.google.com/document/d/16LLelZ7WEKrnbocrl0Az74JqkCv5DBZ9QILRBUFJQt8/edit?tab=t.0#heading=h.x2xfezioy6y1

Acceptance Criteria

Generated by Zenhub AI

[x] Scenario: Understanding Alembic versioning
- Given the developer has read the documentation and artifacts
- When the developer attempts to upgrade or rollback individual migrations
- Then they should be able to understand how to manage these processes effectively
- [x] Scenario: Faster maintenance of database migration scripts
- Given a developer is working with Alembic versioning
- When they are required to fix and maintain migration scripts
- Then the developer should experience faster and more effective management of these tasks
- [x] Scenario: Enhanced knowledge of Alembic versioning processes
- Given the developer has learned from the provided tips and tricks
- When the developer is faced with a migration issue
- Then they should be able to apply their newfound knowledge to resolve the issue more efficiently

P0NDER0SA commented 1 month ago

https://flask-migrate.readthedocs.io/en/latest/

P0NDER0SA commented 1 month ago

Please feel free to review and move this to done! ;)