coderedcms/docs/releases/v0.19.0.rst

CodeRed CMS 0.19.0 release notes
================================


Bug fixes
---------

* Support custom image models by correctly using  ``WAGTAILIMAGES_IMAGE_MODEL``
  versus hard-coding ``wagtailimages.Image``.

* ``coderedcms start`` now pins the version of CodeRed CMS in the generated
  ``requirements.txt`` file.


New features
------------

* Upgraded to Wagtail 2.9

* Upgraded to Bootstrap 4.5 and jQuery 3.5.1


Upgrade considerations
----------------------

* For Wagtail 2.9 ``SiteMiddleware`` and ``request.site`` are deprecated.
  Custom code in your project should be updated as so:

  * In python, replace ``request.site`` with ``Site.find_for_request(request)``.

  * In Python, to load a site setting, replace
    ``Setting.for_site(request.site)`` with ``Setting.for_request(request)``.

  * In HTML templates, replace ``request.site`` with:

    ..code-block: html

      {% load wagtailcore_tags %}
      {% wagtail_site as site %}

      <p>Your site name is: {{site.site_name}}</p>

  * Following these changes, you should then remove
    ``wagtail.core.middleware.SiteMiddleware`` from the Django ``MIDDLEWARE``
    (in ``settings/base.py``)

* If you have overridden ``coderedcms/pages/base.html``, you may need to update
  references to ``jquery-3.4.1`` to ``jquery-3.5.1``.

* If using SASS, you may need to update your ``custom.scss`` and/or
  ``_variables.scss`` files accordingly to support Bootstrap 4.5. To see what
  you might need to change in your ``_variables.scss``, see `the variables diff
  of Bootstrap 4.3 to 4.5`_. Or to continue using Bootstrap 4.3, `download a
  copy of the Bootstrap 4.3 sources`_ and change the references in your
  ``custom.scss`` to use these files.

* It is assumed that all CodeRed CMS sites prior to 0.19 are using the built-in
  Wagtail Image model, as this was previously hard-coded in CodeRed CMS. If (and
  only if) you plan to switch to a custom image model, a custom data migration
  will be necessary. This migration would follow the same process as any other
  Wagtail installation; there is nothing unique relating to CodeRed CMS.

* You may need to run ``python manage.py makemigrations website`` and
  ``python manage.py migrate`` after upgrading.


.. _the variables diff of Bootstrap 4.3 to 4.5: https://github.com/coderedcorp/coderedcms/commit/fa852ebc9d714d34b25c390321e5a6d563156097#diff-a68086c64c5d52852fda5605321c3eb9
.. _download a copy of the Bootstrap 4.3 sources: https://getbootstrap.com/docs/4.3/getting-started/download/