Skip to content

Commit

Permalink
docs(CHANGES): Note migration onramp
Browse files Browse the repository at this point in the history
  • Loading branch information
tony committed Oct 15, 2022
1 parent 8bef904 commit 36cbd06
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@ master (unreleased)
-------------------
*This is where upcoming changes will be.*

Breaking change: Missing ``DEFAULT_AUTO_FIELD``
"""""""""""""""""""""""""""""""""""""""""""""""
This sets a ``DEFAULT_AUTO_FIELD`` to ``BigAutoField`` for robots in ``AppConfig``. Previously,
there was no app configuration or setting for this. (#134, thank you @jan-szejko-steelseries)

Robots 5.0 included a ``BigAutoField`` migration file for django 3.2 support (see #112),
however, this caused an extra migration to be created to set ``django.db.models.AutoField``
for certain users (see #124).

**Breaking: Migration issues**

New django sites should work fine.

*Existing sites that manually created migrations for robots 5.0:*

If you ran ``./manage.py makemigrations`` to bypass the #112 issue, you may need to resolve
this manually if a custom migration you made for robots was applied in ``django_migrations``.

Resources:
- https://docs.djangoproject.com/en/4.1/releases/3.2/#customizing-type-of-auto-created-primary-keys
- https://docs.djangoproject.com/en/3.2/ref/settings/#std-setting-DEFAULT_AUTO_FIELD

Maintenance
"""""""""""
- Remove django-south migrations folder (#138)

5.0 (2022-01-08)
Expand Down

0 comments on commit 36cbd06

Please sign in to comment.