Skip to Content

Release Notes for $doc.getValue('product') $doc.getValue('version')

Version 11.10 by Thomas Mortagne on 2025/01/30
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Contents

This is the release notes for XWiki Commons, XWiki Rendering and XWiki Platform. They share the same release notes as they are released together and have the same version.

This is the first release of the 17.x cycle. The most notable change is the move to Jakarta EE 9.1 that allows XWiki to run on recent versions of the supported application servers (like Tomcat 10+ and Jetty 12 EE9/10). Make sure to read the migration notes though since this change can potentially break backwards compatibility. Besides this, it's worth mentioning the new sort parameter for the Document Tree and Children macros, and the new notification email headers for auto-replies. Being the start of a new cycle we also took the opportunity to upgrade of a lot of our dependencies.

This release contains security fixes, with the highest severity being 8.7/10.

New and Noteworthy (since Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.
16.10.2)

Full list of issues fixed and Dashboard for 17.0.0.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Moved Modules

Upgrades

The following runtime dependencies have been upgraded (they have a different release cycle than XWiki Commons, XWiki Rendering and XWiki Platform):

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Translations

The following translations have been updated: 

Security Issues

Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the XWiki Security Policy for more details.

Known issues

Backward Compatibility and Migration Notes

General Notes

  • When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
    • xwiki.cfg
    • xwiki.properties
    • web.xml
    • hibernate.cfg.xml
  • Add xwiki.store.migration=1 in xwiki.cfg so that XWiki will attempt to automatically migrate your current database to any new schema. Make sure you backup your Database before doing anything.

Issues specific to Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Move to Jakarta EE 9.1

XWiki has been migrated to Jakarta EE 9.1 specification.

The most notable change is that it means it now requires corresponding application servers: Tomcat 10+ and Jetty 11+ for example.
But the biggest difference between Jakarta EE 8 and 9.x is the move from javax.* to jakarta.* packages, so this migration commes with some potential breakages:

  • Servlet 5 (javax.servlet -> jakarta.servlet): XWiki comes with a bridge that should make the upgrade transparent from extensions, it mainly means that a lot of Servlet related API is now deprecated and application authors should move to new ones, most notably all the request related APIs from xwiki-platform-oldcore are replaced by org.xwiki.container.Container based APIs. Also XWiki is now doing its best (in Jetty and Tomcat only right now) by default to enable everything it can find to allow any character in URLs at init, it's possible to disable this using the property url.forceAllowAnyCharacter in the xwiki.properties configuration file (but it will most probably prevent some XWiki features to work property, see XWIKI-19167 for more details)
  • WebSocket 2.1 (javax.websocket -> jakarta.websocket): there is no bridge here. If you were directly manipulating javax.websocket APIs, you will have to move to jakarta.websocket and all XWiki APIs that were exposing javax.websocket have been modified to expose the jakarta.websocket versions.
  • Validation 3: there is no bridge either here, so you have to move to the jakarta.validation versions of the annotations. Since Jakarta Validation is only annotations, you can actually use both at the same time if you want to support different versions of XWiki in your extension for example.

Move javax.* to jakarta.* migration will happen in the course of the 17.x XWiki cycle. See Jakartamigration for more details about that.

Redirect behavior changes

  • Trusted domains are checking for all redirect called in XWiki now, it used to be only code going through XWikiRequest.
  • By default relative redirect are now resolved by XWiki instead of the application server. The goal was to reduce the configuration need (XWiki has all the information to properly resolve the redirect and the application server sometimes require some more setup), but if this change cause problem you can move back to using the application server using the property container.request.resolveRelativeRedirect in the xwiki.properties configuration file.

CSS name changed in xwiki-platform-notifications-webjar

Due to an upgrade of vite package used for building xwiki-platform-notifications-webjar the CSS file generated is now named main.css instead of style.css. Pay attention to use that new name for loading the file starting with XWiki 17.0.0.

API Breakages

The following APIs were modified since Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.
16.10.2:

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:ReleaseNotes.Data.XWiki.17\.0\.0.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

Credits

The following people have contributed code and translations to this release (sorted alphabetically):

  • Cye3s
  • Lucas C
  • Manuel Leduc
  • Marius Dumitru Florea
  • Maximilien Cuony
  • Michael Hamann
  • Nikita Petrenko
  • Simon Urli
  • Simpel
  • Thomas Mortagne
  • Vincent Massol
  • jasongwq
  • xrichard

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected