v1.1.2

ambient-innovation · Dec 15, 2023 · 9931254 · 9931254
1 parent 0bf82e8
commit 9931254
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,7 +1,10 @@
 # Changelog
 
+* *1.1.2* (2023-12-15)
+  * Improved documentation
+
 * *1.1.1* (2023-12-06)
-  * Improved documentations
+  * Improved documentation
 
 * *1.1.0* (2023-12-05)
   * Added Django 5.0 support

diff --git a/django_migration_zero/__init__.py b/django_migration_zero/__init__.py
@@ -3,4 +3,4 @@
 Holistic implementation of "migration zero" pattern for Django covering local changes and in-production database adjustments.
 """
 
-__version__ = "1.1.1"
+__version__ = "1.1.2"
diff --git a/docs/features/02_configuration.md b/docs/features/02_configuration.md
@@ -1,5 +1,7 @@
 # Configuration
 
+# Settings
+
 This package requires all local Django apps to be inside a single directory. This directory needs to be defined in the
 main django settings.
 
@@ -10,3 +12,23 @@ Note that this variable has to be of type `pathlib.Path`.
 ```python
 MIGRATION_ZERO_APPS_DIR = BASE_DIR / "apps"
 ```
+
+## Logging
+
+The scripts are quite chatty. If you want to see what's going on under the hood, just configure a quite default-looking
+logger in your Django settings.
+
+Note, that in this example, we are only logging to the console.
+
+```python
+LOGGING = {
+    "loggers": {
+        "django_migration_zero": {
+            "handlers": ["console"],
+            "level": "INFO",
+            "propagate": True,
+        },
+        ...
+    },
+}
+```
diff --git a/docs/features/04_common_issues_and_solutions.md b/docs/features/04_common_issues_and_solutions.md
@@ -23,3 +23,9 @@ If you pushed your migration zero commit with all those removed and changed migr
 active, you'll encounter a crash when running `manage.py migrate`. Since the migration history is out-of-sync with the
 files you just deployed, the migration shouldn't do anything except failing, and you should be OK in 95% of all cases.
 Just activate the flag and redeploy.
+
+## What happens to data migrations (RunPython)? They won't be recreated by Django!
+
+To start with this process, you must make sure that all migrations have been applied to every environment. This means
+that all custom-built data migration you might have, are obsolete by the point you want to start cleaning up your
+migrations. Therefore, you can let them be deleted without any second thoughts.