5.2.0 release notes¶

Month DD, YYYY

Welcome to django CMS 5.2.0!

These release notes cover the new features, as well as some backwards incompatible changes you need to consider when upgrading from django CMS 5.1.x or earlier. Read the upgrade instructions and removed-functionality section before updating an existing project.

Django and Python compatibility¶

django CMS 5.2 supports Django X.Y and Z.0. TODO: state which series are no longer supported and why. We highly recommend and only support the latest release of each supported series.

It supports Python 3.x, 3.y, and 3.z.

Release highlights¶

TODO: one or two sentences on the theme of this release.

Highlight 1. TODO: what the user can now do, and why it matters.
Highlight 2. TODO.
Highlight 3. TODO.

How to upgrade to 5.2.0¶

Before upgrading, back up your database and uploaded media and review the backward-incompatible changes below. TODO: note any minimum Django version or removed APIs.

Upgrade django CMS and ensure that your environment contains a compatible Django version:

python -m pip install --upgrade "django-cms==5.2.0" "Django>=X.Y"

Then apply migrations, collect static files, and run the django CMS checks:

python manage.py migrate
python manage.py collectstatic --noinput
python manage.py cms check

Test custom plugins, apphooks, permissions, frontend editing, and all templates in a staging environment before deploying. TODO: add any release-specific upgrade caveats.

What’s new in 5.2.0¶

Feature 1¶

TODO: describe the feature — what changed, what users see, and how to use it.

Feature 2¶

TODO: describe the feature.

Sub-topic of feature 2¶

TODO: details, examples, or configuration for the feature above.

Example:

# TODO: replacement code sample

TODO: link to the relevant how-to or reference page.

Feature 3¶

TODO: describe the feature.

Minor features¶

TODO: minor feature 1.
TODO: minor feature 2.
TODO: minor feature 3.

Security fixes¶

TODO: describe each security-relevant fix, who is affected, and any action required beyond upgrading. Reference the advisory where one was published.

TODO: security fix 1
TODO: security fix 2

Bug Fixes¶

TODO: notable bug fix 1
TODO: notable bug fix 2
TODO: notable bug fix 3

TODO: point at the full list of fixes in CHANGELOG.rst.

Backward incompatible changes in 5.2.0¶

Backward incompatible change 1¶

TODO: what changed, who is affected, and what to do instead.

Backward incompatible change 2¶

TODO: what changed, who is affected, and what to do instead.

Dependencies, settings, and migrations¶

TODO: new or raised dependencies, changed defaults, and new migrations.

Features deprecated in 5.2.0¶

Deprecation area 1¶

TODO: what is deprecated, when it will be removed, and the replacement.

Deprecation area 2¶

TODO: what is deprecated, when it will be removed, and the replacement.

Removal of deprecated functionality¶

Removal area 1¶

TODO: what was removed and what to use instead.

Removal area 2¶

TODO: what was removed and what to use instead.