v0.19.0.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. CodeRed CMS 0.19.0 release notes
  2. ================================
  3. Bug fixes
  4. ---------
  5. * Support custom image models by correctly using ``WAGTAILIMAGES_IMAGE_MODEL``
  6. versus hard-coding ``wagtailimages.Image``.
  7. * Fix custom CSS class and Google Maps API key in Google Map block.
  8. * ``coderedcms start`` now pins the version of CodeRed CMS in the generated
  9. ``requirements.txt`` file.
  10. New features
  11. ------------
  12. * Upgraded to Wagtail 2.9
  13. * Upgraded to Bootstrap 4.5 and jQuery 3.5.1
  14. * ``coderedcms start`` no longer creates a boilerplate Dockerfile. This has
  15. been replaced with a more thorough guide: :doc:`/how_to/docker`.
  16. Upgrade considerations
  17. ----------------------
  18. * For Wagtail 2.9 ``SiteMiddleware`` and ``request.site`` are deprecated.
  19. Custom code in your project should be updated as so:
  20. * In python, replace ``request.site`` with ``Site.find_for_request(request)``.
  21. * In Python, to load a site setting, replace
  22. ``Setting.for_site(request.site)`` with ``Setting.for_request(request)``.
  23. * In HTML templates, replace ``request.site`` with:
  24. ..code-block: html
  25. {% load wagtailcore_tags %}
  26. {% wagtail_site as site %}
  27. <p>Your site name is: {{site.site_name}}</p>
  28. * Following these changes, you should then remove
  29. ``wagtail.core.middleware.SiteMiddleware`` from the Django ``MIDDLEWARE``
  30. (in ``settings/base.py``)
  31. * If you have overridden ``coderedcms/pages/base.html``, you may need to update
  32. references to ``jquery-3.4.1`` to ``jquery-3.5.1``.
  33. * If using SASS, you may need to update your ``custom.scss`` and/or
  34. ``_variables.scss`` files accordingly to support Bootstrap 4.5. To see what
  35. you might need to change in your ``_variables.scss``, see `the variables diff
  36. of Bootstrap 4.3 to 4.5`_. Or to continue using Bootstrap 4.3, `download a
  37. copy of the Bootstrap 4.3 sources`_ and change the references in your
  38. ``custom.scss`` to use these files.
  39. * It is assumed that all CodeRed CMS sites prior to 0.19 are using the built-in
  40. Wagtail Image model, as this was previously hard-coded in CodeRed CMS. If (and
  41. only if) you plan to switch to a custom image model, a custom data migration
  42. will be necessary. This migration would follow the same process as any other
  43. Wagtail installation; there is nothing unique relating to CodeRed CMS.
  44. * You may need to run ``python manage.py makemigrations website`` and
  45. ``python manage.py migrate`` after upgrading.
  46. .. _the variables diff of Bootstrap 4.3 to 4.5: https://github.com/coderedcorp/coderedcms/commit/fa852ebc9d714d34b25c390321e5a6d563156097#diff-a68086c64c5d52852fda5605321c3eb9
  47. .. _download a copy of the Bootstrap 4.3 sources: https://getbootstrap.com/docs/4.3/getting-started/download/