Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release notes for 4.2.0 #1827

Draft
wants to merge 15 commits into
base: master
Choose a base branch
from
49 changes: 49 additions & 0 deletions source/release-notes/4-2-0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. index:: CrafterCMS 4.2.0 Release Notes

----------------
CrafterCMS 4.2.0
----------------

Released *TBD*

.. important::

Please see :ref:`Breaking changes <breaking-changes-4-2-x>` for breaking changes and other
things to consider before upgrading

For instructions on how to update your CrafterCMS install to 4.2.x,
please see :ref:`upgrading-craftercms`

^^^^^^^^^^^^
New Features
^^^^^^^^^^^^

^^^^^^^^^^^^
Enhancements
^^^^^^^^^^^^

^^^^^^^^^
Bug Fixes
^^^^^^^^^

^^^^^^^^^^^^^^^^^^
Dependency Updates
^^^^^^^^^^^^^^^^^^
* Noteworthy dependency updates:

- Spring Framework to version 6
- Spring Boot to version 3
- Freemarker to version 2.3.33
- MariaDb4J to version ``3.1.0.1`` and MariaDB to ``11.3.2``
- HTTP Proxy to version 2.0
- UrlRewriteFilter to version 5.1.3
sumerjabri marked this conversation as resolved.
Show resolved Hide resolved
- ESAPI to version 2.5.3.1
- FileUpload to version 2.0.0-M2
sumerjabri marked this conversation as resolved.
Show resolved Hide resolved
- Groovy to version 4
- Tomcat to version 10

For a complete list of community tickets, please visit: `GitHub 4.2.0 <https://github.com/orgs/craftercms/projects/6/views/1>`_

For information on upgrading 3.1.x sites, see :ref:`here <compatibility-with-3.1.x>`

|hr|
32 changes: 32 additions & 0 deletions source/release-notes/4-2-x-breaking-changes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
:orphan:
:is-up-to-date: False
:last-updated: 4.2.0

.. _breaking-changes-4-2-x:

====================================
Breaking Changes in CrafterCMS 4.2.x
====================================
This section covers changes that might affect your CrafterCMS projects, as well as other considerations
before upgrading. Please review the following and apply changes as required:

- CrafterCMS 4.2.x requires Java 21. |br| See :ref:`Requirements <requirements_supported_platforms>` for more
information on CrafterCMS requirements.

.. .. _compatibility-with-3.1.x:

- **Upgrading 3.1.x sites** |br|

- MongoDB in CrafterCMS Social and Profile has been updated. To upgrade MongoDB in your installation, see
:ref:`upgrading-mongodb`

- CrafterCMS 4.1.x onward requires Git. |br| See :ref:`Requirements <requirements_supported_platforms>` for more
information on CrafterCMS requirements.

- CrafterCMS 4.1.x onward has a new Studio UI. To get the same Sidebar you're used to, update
the :ref:`user-interface-configuration`

- Update ICE to move to :ref:`XB <experience-builder>`

- Studio and Engine SAML configuration now uses a key and certificate for configuration instead of using keystore. |br|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For many of these changes, are they the same as 4.1? Let's discuss if they are.

See :ref:`engine-saml2-configuration` and :ref:`crafter-studio-configure-studio-saml` for more information.