feat: (Re-) Introduce static aliases in the structure board (#283)

* chore: Refactor for djangocms-versioning 2.4

* feat: Re-introduce placeholders for static aliases in structure board

* fix: tests

* tests: update requirement files

* Update djangocms_alias/rendering.py

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>

* tests: Update requirements

* chore: Code improvement

* tests: Add test for static alias in structure board

* chore: Collect project meta information in pyproject.toml

* ci: auto fixes from pre-commit hooks

for more information, see https://pre-commit.ci

* fix: tox.ini

* tests: Update environment - switch to pytest

* fix: remove unnecessary distutil dependency

* fix: tox.ini

* fix: Remove tests against django main from required tests

* fix: Add default_auto_field, update migration to atomic transaction

* Update locales

* Update German locale

* fix: Cache template rendering results

* fix: Deactivate static alias caching in dev mode

* perf: DB optimization of template tag

* perf: Save prefetch query

---------

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

.editorconfig

@@ -15,7 +15,6 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - 3.9
           - '3.10'
           - '3.11'
           - '3.12'
@@ -80,7 +79,7 @@ jobs:
           name: html-report
           path: htmlcov
 
-  unit-tests-django-main:
+  unit-tests-dev:
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -108,5 +107,5 @@ jobs:
         python -m pip install -e .
 
     - name: Run coverage
-      run: coverage run ./test_settings.py
+      run: coverage run -m pytest
       continue-on-error: true

.eslintrc.js

@@ -14,3 +14,4 @@ htmlcov
 .python-version
 venv*
 node_modules
+.editorconfig

.github/workflows/test.yml

@@ -4,19 +4,32 @@
 django CMS Alias
 ****************
 
-|coverage| |python| |django| |djangocms4|
+|PyPiVersion| |Coverage| |DjVersion| |CmsVersion|
 
-django CMS Alias replicates and extends the alias function of django CMS version 3 for django CMS version 4.
+django CMS Alias replicates and extends the alias function of django CMS version 3 for
+django CMS version 4 and later.
 
-An alias is a collection of plugins that is managed centrally. A reference can be added to any placeholder using the Alias plugin. Since the Alias plugin creates a reference any changes to the alias are immediately reflected at all places it is used.
+An alias is a collection of plugins that is managed centrally. A reference can be added to
+any placeholder using the Alias plugin. Since the Alias plugin creates a reference any changes
+to the alias are immediately reflected at all places it is used.
+
+Aliases are created and edited independently of their usage through their own dedicated editing
+endpoints, i.e. outside of django CMS pages. This allows content managers to maintain alias
+content without needing to navigate to a page where the alias is used.
+
+When editing a page that contains static aliases, these aliases are shown in the structure board,
+providing visibility into the alias' content while maintaining the separation between alias management
+and page editing. If the static alias can be changed, it is fully accessible through the structure board.
+
+Static aliases cannot be changed in the structure board on views that have no editing interface.
 
 django CMS Alias supports versioning aliases by django CMS Versioning.
 
 .. warning::
 
-    This is the development branch for django CMS version 4.1 support.
+    django CMS Alias 3 and later require django CMS 5.0 or later.
 
-    For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-alias/tree/support/django-cms-4.0.x>`_
+    Use ``djangocms-alias>=2,<3`` for django CMS 4.1.
 
 
 ============
@@ -34,7 +47,7 @@ To install
 
 Run::
 
-    pip install git+https://github.com/django-cms/djangocms-alias@master#egg=djangocms-alias
+    pip install djangocms-alias
 
 Add ``djangocms_alias`` and ``parler`` to your project's ``INSTALLED_APPS``.
 
@@ -65,20 +78,27 @@ Example::
 Alias plugin
 ============
 
-Alternatively, aliases can be used with the Alias plugin. It allows to select which alias content is shown at the exact position the alias plugin is placed.
+Alternatively, aliases can be used with the Alias plugin. It allows to select which alias content is shown at the
+exact position the alias plugin is placed.
 
-.. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-alias/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/django-cms/djangocms-alias
+Side notes
+==========
+For the plugin to work out of the box ``{% block content %}`` is expected to exist in your main ``base.html`` file.
 
-.. |python| image:: https://img.shields.io/badge/python-3.9+-blue.svg
-   :target: https://pypi.org/project/djangocms-alias/
+.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-alias.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-alias
+    :alt: Latest PyPI version
+.. |Coverage| image:: https://codecov.io/gh/django-cms/djangocms-alias/graph/badge.svg?token=UUkVjsHGcA
+ :target: https://codecov.io/gh/django-cms/djangocms-alias
 
-.. |django| image:: https://img.shields.io/badge/django-4.2+-blue.svg
-   :target: https://www.djangoproject.com/
+.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-alias.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-alias
+    :alt: Python versions
 
-.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4+-blue.svg
-   :target: https://www.django-cms.org/
+.. |DjVersion| image:: https://img.shields.io/pypi/frameworkversions/django/djangocms-alias.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-alias
+    :alt: Django versions
 
-Side notes
-============
-For the plugin to work out of the box ``{% block content %}`` is expected to exist in your main ``base.html`` file.
+.. |CmsVersion| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-alias.svg?style=flat-square
+    :target: https://pypi.python.org/pypi/djangocms-alias
+    :alt: django CMS versions

.gitignore

@@ -3,4 +3,4 @@
 A reference can be added to any placeholder using the Alias plugin.
 """
 
-__version__ = "2.0.5"
+__version__ = "3.0.0"