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 25 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
d9bd934
Start release notes for 4.2.0
alhambrav May 14, 2024
581d6b0
Update
alhambrav May 14, 2024
5b62ff8
Fix duplicated item
alhambrav May 14, 2024
ebe38ed
Update link for Github 4.2.0
alhambrav May 14, 2024
7f535ca
Updates based on review
alhambrav May 14, 2024
176c832
Merge branch 'master' into rn-4-2-0
alhambrav Jul 22, 2024
06c8596
Add to release notes ~DASHBOARD~
alhambrav Jul 22, 2024
0ef02d7
Updates for permissions release notes
alhambrav Jul 22, 2024
1109441
Update release notes for new Crafter CLI commands #6941
alhambrav Jul 23, 2024
b2c06f3
Update release notes for RTE config for template plugin #886
alhambrav Jul 24, 2024
4666bae
Updates based on review
alhambrav Jul 25, 2024
3e03dc1
Updates to release notes
alhambrav Aug 8, 2024
f174a96
Merge branch 'master' into rn-4-2-0
alhambrav Aug 12, 2024
59826fd
Update notes
alhambrav Aug 12, 2024
231720a
Add to list of new CLI options #7153
alhambrav Aug 16, 2024
5ce287e
Some more updates to release notes
alhambrav Sep 19, 2024
4eb7a3a
Updates based on review
alhambrav Sep 20, 2024
6d5df3c
Update based on review
alhambrav Sep 24, 2024
ae2394f
Merge branch 'master' of https://github.com/craftercms/docs into rn-4…
alhambrav Sep 25, 2024
5c5f435
Update release notes
alhambrav Oct 1, 2024
57a8ff2
Update release notes with some more tickets
alhambrav Oct 10, 2024
f7aad16
Update version for MariaDb and add new parameter to release notes
alhambrav Oct 11, 2024
bac728b
Merge branch 'master' into rn-4-2-0
alhambrav Oct 16, 2024
023963b
Update release notes
alhambrav Oct 16, 2024
fe2b2aa
Update release notes with UI dependencies
alhambrav Oct 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
author = u'CrafterCMS'

# The short X.Y version.
version = u'4.1'
version = u'4.2'
# The full version, including alpha/beta/rc tags.
release = u'4.1.5'
release = u'4.2.0'


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -139,7 +139,7 @@

# Add versions for the bottom menu
html_context = {
'versions': ['4.1', '4.0', '3.1'],
'versions': ['4.2', '4.1', '4.0'],
'docsUrl': 'https://docs.craftercms.org'
}

Expand Down Expand Up @@ -267,7 +267,7 @@

# Javadoc home and version
javadoc_base = 'http://javadoc.craftercms.org/'
javadoc_version = '4.1.5'
javadoc_version = '4.2.0'

# Shorten external links
extlinks = {'javadoc_base_url': (javadoc_base + javadoc_version + '/%s', None ),
Expand Down
99 changes: 99 additions & 0 deletions source/release-notes/4-2-0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
.. 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
^^^^^^^^^^^^
* New authentication mechanism for Engine Preview |br|
To learn more about configuring Engine Preview, see :ref:`studio-preview-cookie` and :ref:`engine-security-preview-mode`

* Crafter CLI has the following new options:

- Publish Content
- Create Group
- List Groups
- Create User
- Get Users

Please see :ref:`crafter-cli` for more information.

* New RTE configuration for TinyMCE plugin ``template``
Please see :ref:`rte-configuration-tinymce-plugin-template-example` for more information

* YAML, JSON and CSV files are now editable via the "Edit" option in Preview |br|
See `here <https://github.com/craftercms/craftercms/issues/6980>`__ for more information

* Image placeholder generation util is now integrated into XB |br|
When generating items on XB, fields without default values use ``placehold.it`` for images.
See `here <https://github.com/craftercms/craftercms/issues/6668>`__ for more information

* Broken dependencies are now recorded in the DB and with every content written, if the item being written is referenced
as a broken dependency, the reference will be fixed. |br|
See `here <https://github.com/craftercms/craftercms/issues/6228>`__ for more information


^^^^^^^^^^^^
Enhancements
^^^^^^^^^^^^
* Improved permissions.

- Added a new permission, ``publish_by_commits``, that allows users to publish by commit ids. See the API
`publishCommits <../_static/api/studio.html#tag/publishing/operation/publishCommits>`__ for permission usage.
- Items are evaluated for permissions based on their paths regardless of where they are listed. The permission
``~DASHBOARD~`` is now removed from the list of allowed permissions. The upgrade manager will remove it from your
project during your install upgrade.

* `Added support for multiple browser tabs for the same project/site <https://github.com/craftercms/craftercms/issues/6206>`__
* `Set the default sort order of Studio UI search to alphabetical when no keyword is supplied <https://github.com/craftercms/craftercms/issues/5995>`__
* Bulk Publishing enhancements

* `Added an option to include soft dependencies when bulk publishing <https://github.com/craftercms/craftercms/issues/6191>`__
This new option is set to false by default.
* `Studio now does a \"Publish All\" request when \"Publish By Path='/'\" request is received <https://github.com/craftercms/craftercms/issues/5950>`__


* Improved XB ease-of-use and resilience for JS apps programmatically registering elements for XB |br|
See `here <https://github.com/craftercms/craftercms/issues/6983>`__ for more information

For more information on registering elements for XB, see :ref:`xb-lazy-loaded-content`.


^^^^^^^^^
Bug Fixes
^^^^^^^^^
* `Fixed issues with dependency calculations \"getDependentItems\" <https://github.com/craftercms/craftercms/issues/6189>`__

^^^^^^^^^^^^^^^^^^
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`` and MariaDB to ``11.3``
Copy link
Member

Choose a reason for hiding this comment

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

Separate into two different lines (to highlight the MariaDB upgrade) and lead with MariaDB not MariaDB4j.

- HTTP Proxy to version 2.0
- UrlRewriteFilter to version 5.1.
- ESAPI to version 2.5.3.1
- FileUpload to version 2.0
- 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|
Copy link
Member

Choose a reason for hiding this comment

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

Let's make this a section instead of just bolding it.


- 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|
sumerjabri marked this conversation as resolved.
Show resolved Hide resolved
See :ref:`engine-saml2-configuration` and :ref:`crafter-studio-configure-studio-saml` for more information.
17 changes: 8 additions & 9 deletions source/release-notes/index.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
:is-up-to-date: True
:last-updated: 4.1.5
:last-updated: 4.2.0

.. _release-notes:

=============
Release Notes
=============
This section contains release notes for CrafterCMS 4.1. For other release notes, please visit your
This section contains release notes for CrafterCMS 4.2. For other release notes, please visit your
release's release notes page here: http://docs.craftercms.org or :ref:`see below <other-release-notes>`

.. note:: CrafterCMS 4.1.x requires Java 17
.. note:: CrafterCMS 4.1.x requires Java 21

.. include:: /release-notes/4-1-5.rst
.. include:: /release-notes/4-1-4.rst
.. include:: /release-notes/4-1-3.rst
.. include:: /release-notes/4-1-2.rst
.. include:: /release-notes/4-1-1.rst
.. include:: /release-notes/4-1-0.rst
.. include:: /release-notes/4-2-0.rst

.. _other-release-notes:

For CrafterCMS version 4.1 release notes, see https://docs.craftercms.org/en/4.1/release-notes/index.html

|hr|

For CrafterCMS version 4.0 release notes, see https://docs.craftercms.org/en/4.0/release-notes/index.html

|hr|
Expand Down