Преглед изворни кода

Bump version to 3.0 and add release notes

Vince Salvino пре 1 година
родитељ
комит
a09106b533
3 измењених фајлова са 53 додато и 2 уклоњено
  1. 1 1
      coderedcms/__init__.py
  2. 4 1
      docs/releases/index.rst
  3. 48 0
      docs/releases/v3.0.0.rst

+ 1 - 1
coderedcms/__init__.py

@@ -14,7 +14,7 @@ Maintains version of coderedcms.
 
 See: https://www.python.org/dev/peps/pep-0440/
 """
-release = ["2", "1", "0", "", "dev0"]
+release = ["3", "0", "0", "", "dev0"]
 
 
 def _get_version() -> str:

+ 4 - 1
docs/releases/index.rst

@@ -15,7 +15,9 @@ Supported Versions:
 +--------------+---------+----------+---------------------------+
 | CRX version  | Wagtail | Python   | Support Status            |
 +==============+=========+==========+===========================+
-| CRX 2.x      | 4.x     | 3.7-3.11 | Supported                 |
+| CRX 3.x      | 5.x     | 3.8-3.12 | Supported                 |
++--------------+---------+----------+---------------------------+
+| CRX 2.x      | 4.x     | 3.7-3.11 | Support contract required |
 +--------------+---------+----------+---------------------------+
 | CRX 1.x      | 3.x     | 3.7-3.11 | Support contract required |
 +--------------+---------+----------+---------------------------+
@@ -25,6 +27,7 @@ Supported Versions:
 .. toctree::
     :maxdepth: 1
 
+    v3.0.0
     v2.1.4
     v2.1.3
     v2.1.2

+ 48 - 0
docs/releases/v3.0.0.rst

@@ -0,0 +1,48 @@
+v3.0.0 release notes
+====================
+
+
+New features
+------------
+
+* Support Wagtail 5.0, 5.1, and 5.2.
+
+* Support Python 3.8 to 3.12
+
+* Includes Bootstrap 5.3
+
+* New projects now include ``EventPage`` and ``LocationPage`` in ``models.py`` by default.
+
+* New project template: ``pro``. This is the highly recommended starting point for larger projects or paying clients. It includes:
+
+  * Custom User, Image, and Document models by default.
+
+  * ``ruff`` linter and formater pre-configured.
+
+  * ``pytest`` pre-configured.
+
+  * ``mypy`` pre-configured.
+
+
+Bug fixes
+---------
+
+* Remove discontinued Google Analytics (Universal Analytics). This was shut down by Google in June 2023.
+
+* Fix issues with custom image models. A bug was introduced in some migrations with 2.0 which hard-coded the wagtail image class in some snippets.
+
+
+Upgrade considerations
+----------------------
+
+This should be a straightforward upgrade with no major functional changes.
+
+Be sure to read the `Wagtail 5 upgrade considerations <https://docs.wagtail.org/en/stable/releases/5.0.html#upgrade-considerations>`_.
+
+If you'd like to add our new developer tooling to your existing project, copy the `pyproject.toml <https://github.com/coderedcorp/coderedcms/blob/main/coderedcms/project_template/pro/pyproject.toml>`_ and `requirements-dev.txt <https://github.com/coderedcorp/coderedcms/blob/main/coderedcms/project_template/pro/requirements-dev.txt>`_. files.
+
+
+Thank you!
+----------
+
+Thanks to everyone who contributed to `3.0.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/50?closed=1>`_.