public/django-migration-linter
15
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document the incompatibility codes

Browse Source
This commit is contained in:
David-Wobrock authored and David Wobrock committed 2020-11-26 19:02:57 +01:00
1 parent b38da345d7
commit 5e26d9a910
1 file changed
+17
Download Patch File Download Diff File Expand all files Collapse all files
docs/incompatibilities.md
+17
View File
@@ -19,3 +19,20 @@ We are happy to add more if you can specify them to us.
On data migrations, the linter will show a warning when:
* you are missing a reverse migration
* the RunPython arguments do not respect the naming convention `apps, schema_editor`
## Codes
You can ignore check through the `--exclude-migration-test` option and specifying any of the codes:
| Code | Description |
|-----------------------------------|----------------------------------------------------------------------|
|`NOT_NULL` | Not NULL constraint on columns
|`DROP_COLUMN` | Dropping columns
|`DROP_TABLE` | Dropping tables
|`RENAME_COLUMN` | Renaming columns
|`RENAME_TABLE` | Renaming tables
|`ALTER_COLUMN` | Altering columns (could be backward compatible)
|`ADD_UNIQUE` | Add unique constraints
|`REVERSIBLE_DATA_MIGRATION` | RunPython data migration is not reversible (missing reverse code)
|`NAMING_CONVENTION_RUNPYTHON_ARGS` | By convention, RunPython names two arguments: apps, schema_editor
|`DATA_MIGRATION_MODEL_IMPORT` | Missing apps.get_model() calls for model