Resolve migration conflicts.
Project description
django-migration-resolver-hook
Django Migration resolver ensures that migration files always stays ordered regardless of remote changes.
Problem:
With generated migration files using Django's manage.py makemigrations
command you could run
into issues where the generated migration files would potentially be out of sync with
remote's master/default branch most CI servers are able to catch this error by running a test based on
your local branch merge back into the base branch there by spotting duplicate migration nodes.
Solution:
This package aims to solve this problem by using a Doubly Linked List while traversing the app's migration file(s) detecting duplicate node(s) and potential conflicts.
When duplicate nodes are detected stat.st_mtime
is used to sort files based on the last modified time.
:warning: This is not always accurate and might require a manual check to validate changes.
NOTE: This doesn't require Django's installed apps concept when using CLI commands since this is totally file based and should be executed within the root/app folders.
Table of Contents
Installation
$ pip install django-migration-resolver-hook
Poetry
poetry add -D django-migration-resolver-hook
Usage
Use Case
Remote
|--- migrations
|---- ...
|---- 0007_auto_20200112_2328.py # Shared between remote and local repo
|---- 0008_auto_20200113_4328.py # Only exists on remote
|---- 0009_auto_20200114_4532.py
|---- 0010_auto_20200115_1632.py
Local repo
|--- migrations
|---- ...
|---- 0007_auto_20200112_2328.py # Shared between remote and local repo
|---- 0008_auto_20200114_5438.py # Only exists locally which raises duplicate migration nodes errors.
Since this is now out of sync with the remote branch to sync changes:
:warning: Unstable use Static migration resolver instead.
Using Auto migration resolver
CLI command: auto_migration_resolver
Auto detect and fix migration files by providing the following:
--app-name
: The app_name of the Django application.--strategy
: The strategy used to resolve migration errors (options: "reseed"/"inline"). (Defaults to: "reseed")--exclude
: The list of migration files that should be ignored.--commit
: Perform agit commit
for the changes after moving file old -> new.--verbose
: Verbose command execution.
Usage:
$ auto_migration_resolver --app-name my_app --commit --verbose
Output
...
Using Static migration resolver
CLI command: migration_resolver
Fix migrations by providing the following:
--app-name
: The app_name of the Django application.--last
: Last migration file of the remote that should be the seed of the conflicted migrations with or without the suffix.--conflict
: The migration file which needs to be reseeded from the last migration file.--commit
: Perform agit commit
for the changes after moving file old -> new.--verbose
: Verbose command execution.
Usage:
$ migration_resolver --app-name my_app --last 0010_auto_20200115_1632 --conflict 0008_auto_20200114_5438 --commit --verbose
Output
Fixing migrations...
Updating the conflicting migration file 0008_auto_20200114_5438.py
Succefully updated: 0008_auto_20200114_5438.py.
Renaming the migration file from 0008_auto_20200114_5438.py to 0011_auto_20200114_5438.py
Successfully renamed the migration file.
[my-test-branch c18fca41e] Resolved migration conflicts for 0008_auto_20200114_5438.py → 0011_auto_20200114_5438.py
1 file changed, 1 insertion(+), 1 deletion(-)
rename my_app/migrations/{0008_auto_20200114_5438.py => 0011_auto_20200114_5438.py} (99%)
For more options
$ migration_resolver --help
usage: migration_resolver [-h] [--auto-detect] [--verbose] --app-name APP_NAME --last LAST --conflict CONFLICT [--commit]
Resolve duplicate migration nodes.
optional arguments:
-h, --help show this help message and exit
--auto-detect Auto-detect and fix migration errors. (Not supported)
--verbose Verbose output
--app-name APP_NAME App Name
--last LAST The glob/full name of the final migration file.
--conflict CONFLICT The glob/full name of the final migration file with the conflict.
--commit Commit the changes made.
Using vsc (git/mercurial) when the remote has a migration files that conflict with previous migrations you have locally.
TODO:
- Auto detect and resolve errors with migration nodes.
- Speed up execution using async/await for handling reading nodes.
- Add support for database unapply migration for case of applied migrations.
- Add support to rollback any changes if there are failures in the chain of operation.
- VCS support right now only git is supported (extend to mercurial).
- Document Auto migration strategies.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-migration-resolver-hook-0.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2a0b24fe7845072dbae6041095ff50b3db6326aa46ad414ca5c93d48432a692 |
|
MD5 | 757900ca8785a042cc9b5f7ea1ed4b3b |
|
BLAKE2b-256 | 4a994436685b63316925cbaebeeda93b6d4a24c00b0d160e0bc287e1ae2bf200 |
Hashes for django_migration_resolver_hook-0.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 762b7c3a553d7f3595013ce09691a205fa7fcb851f73db667d427fda2d1a6434 |
|
MD5 | 63b178cc3723b2fb09554b2b6ac7d0b7 |
|
BLAKE2b-256 | 15e1d8199cd60051cc7c00033f3f1f663d6726ce313361f9df40b717476ef905 |