v0.24.0.rst 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. v0.24.0 release notes
  2. =====================
  3. This release is focused primarily on resolving internal tech debt. This
  4. translates to improved reliability and improved developer experience.
  5. New features
  6. ------------
  7. * Navbars and footers are now orderable and support multi-site. This is
  8. configured under **Settings > Layout**.
  9. * Supports Django 4.0.
  10. Upgrade considerations
  11. ----------------------
  12. * Template tag ``codered_settings`` has been renamed ``crx_settings``. You
  13. should find/replace this in any of your HTML or other Django template files.
  14. * Django settings beginning with ``CODERED_*`` have been renamed to ``CRX_*``.
  15. You should find/replace these in your Django settings files.
  16. * ``wagtail-import-export`` has been removed as a dependency. You should remove
  17. this from ``INSTALLED_APPS`` in your Django settings. As a result,
  18. import/export from JSON files has been removed. However we have preserved the
  19. ability to import Pages from CSV files. See :doc:`/features/import_export`.
  20. * Behavior of Navbars and Footers has changed. If your navbar and footer does
  21. not look correct after upgrading, you may need to synchronize your
  22. customizations to ``navbar.html`` and ``footer.html`` with the `stock versions
  23. which can be found here
  24. <https://github.com/coderedcorp/coderedcms/tree/dev/coderedcms/templates/coderedcms/snippets>`_.
  25. Supported software
  26. ------------------
  27. * Python 3.7, 3.8, 3.9, 3.10
  28. * Django 3.2, 4.0
  29. Internal changes
  30. ----------------
  31. The following changes are not publicly documented APIs, but have changed. Most
  32. sites should not be using any of these APIs and therefore can ignore this
  33. section. In case your site deeply hooks into the package, these are here for
  34. reference.
  35. * ``coderedcms.settings.cr_settings`` has been replaced with
  36. ``coderedcms.settings.crx_settings`` which is no longer a dictionary, but an
  37. object which behaves exactly like the Django settings. This object will first
  38. retrieve a Django setting, and if it does not exist, will then load a CRX
  39. default.
  40. * Internal uses of Wagtail ``StreamField`` on concrete models have been replaced
  41. with ``CoderedStreamField`` which will not generate migrations based on block
  42. changes. This effectively eliminites most of our historic migration problems.
  43. As a result, all past migrations have been hand-edited to reflect this change.
  44. No action is required in client sites.
  45. Client sites can freely use ``coderedcms.fields.CoderedStreamField`` in place
  46. of Wagtail's ``StreamField`` to eliminate the giant migrations problem
  47. inherent to Wagtail. However this API is not publicly documented at this time.
  48. * Choice fields on internal concrete models have been replaced with a
  49. lazy-loading mechanism to load choices and defaults at runtime. This further
  50. eliminates historic migration problems.
  51. Thank you!
  52. ----------
  53. Thanks to everyone who contributed to `0.24.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/37?closed=1>`_.