Skip to content

Commit a09106b

Browse files
committed
Bump version to 3.0 and add release notes
1 parent 445e4c4 commit a09106b

3 files changed

Lines changed: 53 additions & 2 deletions

File tree

coderedcms/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
See: https://www.python.org/dev/peps/pep-0440/
1616
"""
17-
release = ["2", "1", "0", "", "dev0"]
17+
release = ["3", "0", "0", "", "dev0"]
1818

1919

2020
def _get_version() -> str:

docs/releases/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Supported Versions:
1515
+--------------+---------+----------+---------------------------+
1616
| CRX version | Wagtail | Python | Support Status |
1717
+==============+=========+==========+===========================+
18-
| CRX 2.x | 4.x | 3.7-3.11 | Supported |
18+
| CRX 3.x | 5.x | 3.8-3.12 | Supported |
19+
+--------------+---------+----------+---------------------------+
20+
| CRX 2.x | 4.x | 3.7-3.11 | Support contract required |
1921
+--------------+---------+----------+---------------------------+
2022
| CRX 1.x | 3.x | 3.7-3.11 | Support contract required |
2123
+--------------+---------+----------+---------------------------+
@@ -25,6 +27,7 @@ Supported Versions:
2527
.. toctree::
2628
:maxdepth: 1
2729

30+
v3.0.0
2831
v2.1.4
2932
v2.1.3
3033
v2.1.2

docs/releases/v3.0.0.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
v3.0.0 release notes
2+
====================
3+
4+
5+
New features
6+
------------
7+
8+
* Support Wagtail 5.0, 5.1, and 5.2.
9+
10+
* Support Python 3.8 to 3.12
11+
12+
* Includes Bootstrap 5.3
13+
14+
* New projects now include ``EventPage`` and ``LocationPage`` in ``models.py`` by default.
15+
16+
* New project template: ``pro``. This is the highly recommended starting point for larger projects or paying clients. It includes:
17+
18+
* Custom User, Image, and Document models by default.
19+
20+
* ``ruff`` linter and formater pre-configured.
21+
22+
* ``pytest`` pre-configured.
23+
24+
* ``mypy`` pre-configured.
25+
26+
27+
Bug fixes
28+
---------
29+
30+
* Remove discontinued Google Analytics (Universal Analytics). This was shut down by Google in June 2023.
31+
32+
* 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.
33+
34+
35+
Upgrade considerations
36+
----------------------
37+
38+
This should be a straightforward upgrade with no major functional changes.
39+
40+
Be sure to read the `Wagtail 5 upgrade considerations <https://docs.wagtail.org/en/stable/releases/5.0.html#upgrade-considerations>`_.
41+
42+
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.
43+
44+
45+
Thank you!
46+
----------
47+
48+
Thanks to everyone who contributed to `3.0.0 on GitHub <https://github.com/coderedcorp/coderedcms/milestone/50?closed=1>`_.

0 commit comments

Comments
 (0)