|
| 1 | +.. _upgrade-to-2-0-0: |
| 2 | + |
| 3 | +******************* |
| 4 | +2.4.0 release notes |
| 5 | +******************* |
| 6 | + |
| 7 | +*July 2025* |
| 8 | + |
| 9 | +Welcome to django CMS versioning 2.4.0! |
| 10 | + |
| 11 | +These release notes cover the new features, as well as some backwards |
| 12 | +incompatible changes you’ll want to be aware of when upgrading from |
| 13 | +django CMS versioning 1.x. |
| 14 | + |
| 15 | + |
| 16 | +Django and Python compatibility |
| 17 | +=============================== |
| 18 | + |
| 19 | +django CMS supports **Django 4.2, 5.0, 5.1, and 5.2**. We highly recommend and only |
| 20 | +support the latest release of each series. |
| 21 | + |
| 22 | +It supports **Python 3.9, 3.10, 3.11, and 3.12**. As for Django we highly recommend and only |
| 23 | +support the latest release of each series. |
| 24 | + |
| 25 | +Features |
| 26 | +======== |
| 27 | + |
| 28 | +DefaultGrouperVersioningAdminMixin |
| 29 | +---------------------------------- |
| 30 | + |
| 31 | +The `DefaultGrouperVersioningAdminMixin` is a mixin that combines the functionality of |
| 32 | +both the `StateIndicatorMixin` and the `ExtendedGrouperVersionAdminMixin` into as standard |
| 33 | +recommended way to add versioning UI to grouper admin classes. |
| 34 | + |
| 35 | +It also adds the versioning status indicators and the admin list actions to the grouper |
| 36 | +change list (if not already done). |
| 37 | + |
| 38 | + |
| 39 | +Automatic Mixin Integration for GrouperAdmin |
| 40 | +-------------------------------------------- |
| 41 | + |
| 42 | +* For models using the `GrouperAdmin` of django CMS' core (since 4.1), djangocms-versioning |
| 43 | + now automatically adds a mixin to the admin of versioned grouper models. |
| 44 | +* This eliminates the need for third-party packages to explicitly depend on |
| 45 | + djangocms-versioning for mixin imports, enabling better modularity and |
| 46 | + compatibility with alternative versioning solutions. |
| 47 | +* Inheritance checks ensure full backward compatibility. |
| 48 | + |
| 49 | +Default pattern for versioned models: |
| 50 | + |
| 51 | ++---------+------------------+------------------+----------------------------------------+ |
| 52 | +| Models | Model example | Admin class | Admin mixin | |
| 53 | ++=========+==================+==================+========================================+ |
| 54 | +| Grouper | ``Alias`` | ``GrouperAdmin`` | ``DefaultGrouperVersioningAdminMixin`` | |
| 55 | ++---------+------------------+------------------+----------------------------------------+ |
| 56 | +| Content | ``AliasContent`` | ``ModelAdmin`` | ``VersioningAdminMixin`` | |
| 57 | ++---------+------------------+------------------+----------------------------------------+ |
| 58 | + |
| 59 | +To activate this feature, set the ``grouper_admin_mixin`` property to ``"__default__"`` which |
| 60 | +will cause the ``DefaultGrouperVersioningAdminMixin`` to be used: |
| 61 | + |
| 62 | +.. code-block:: |
| 63 | +
|
| 64 | + VersionableItem( |
| 65 | + ..., |
| 66 | + grouper_admin_mixin="__default__", # or a custom mixin class |
| 67 | + ..., |
| 68 | + ) |
| 69 | +
|
| 70 | +
|
0 commit comments