Release Notes for XWiki 10.11.1

Last modified by Ilie Andriuta on 2019/01/18

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 a bugfix release that covers important issues that we have discovered since 10.11 has been released.

Some important bugs have been discovered since XWiki 10.11.1 has been released:

If one or several of these bugs impact you, then you should wait for the next version of XWiki (10.11.2) that will be released soon!
Note that we still recommend upgrading to this new version if you have 10.11 installed as we have been fixing several major issues since then.

New and Noteworthy (since XWiki 10.11)

Full list of issues fixed and Dashboard for 10.11.1.

All Changes

Tested Browsers & Databases

Here is the list of browsers we support and how they have been tested for this release:

 BrowserTests performed and results
Chrome30.pngGoogle Chrome 71Jira Tickets Marked as Fixed in the Release Notes + Full tests
Firefox30.pngMozilla Firefox 64Full tests
Edge30.pngMicrosoft Edge 17 Full tests
IE30.pngInternet Explorer 11Full tests
Safari30.pngSafari 12Not Tested

Here is the list of databases we support and how they have been tested for this release:

 DatabaseTests performed and results
hypersql.pngHyperSQL 2.4.1 Full tests
mysql.pngMySQL 5.7Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 10Jira Tickets Marked as Fixed in the Release Notes + Full tests

Here is the list of Servlet Containers we support and how they have been tested for this release:

 Servlet ContainerTests performed and results
tomcat-icon.pngTomcatNot Tested
jetty-icon.pngJetty (XWiki Standalone packaging)Jira Tickets Marked as Fixed in the Release Notes + Full tests
jetty-icon.pngJettyNot Tested

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.

API Breakages

The following APIs were modified since XWiki 10.11:

  • As RssMacro now inherits from AbstractBoxMacro, its parameter class needs to inherits from BoxMacroParameters. This could only break compatibility if a class inheriting from RssMacroParameters defines a method with same name and parameters than in BoxMacroParameters but different return type. We consider this risk as acceptable since the chances are very low and in case it occurs, the fix for the user would be easy.
    • Violation type:
      java.class.nonFinalClassInheritsFromNewClass
    • Code:
      ## Old:
      class org.xwiki.rendering.macro.rss.RssMacroParameters

      ## New:
      class org.xwiki.rendering.macro.rss.RssMacroParameters
  • Bad design at fist attempt
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::deleteFilterPreference(java.lang.String) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::deleteFilterPreference(org.xwiki.model.reference.DocumentReference, java.lang.String) throws org.xwiki.notifications.NotificationException
  • Bad design at fist attempt
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::saveFilterPreferences(java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>)

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::saveFilterPreferences(org.xwiki.model.reference.DocumentReference, java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>)
  • Bad design at fist attempt
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::setFilterPreferenceEnabled(java.lang.String, boolean) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceManager::setFilterPreferenceEnabled(org.xwiki.model.reference.DocumentReference, java.lang.String, boolean) throws org.xwiki.notifications.NotificationException
  • Bad design at fist attempt
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::deleteFilterPreference(java.lang.String) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::deleteFilterPreference(org.xwiki.model.reference.DocumentReference, java.lang.String) throws org.xwiki.notifications.NotificationException
  • Bad design at fist attempt
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::saveFilterPreferences(java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::saveFilterPreferences(org.xwiki.model.reference.DocumentReference, java.util.Set<org.xwiki.notifications.filters.NotificationFilterPreference>) throws org.xwiki.notifications.NotificationException
  • Bad design at fist attempt
    • Violation type:
      java.method.numberOfParametersChanged
    • Code:
      ## Old:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::setFilterPreferenceEnabled(java.lang.String, boolean) throws org.xwiki.notifications.NotificationException

      ## New:
      method void org.xwiki.notifications.filters.NotificationFilterPreferenceProvider::setFilterPreferenceEnabled(org.xwiki.model.reference.DocumentReference, java.lang.String, boolean) throws org.xwiki.notifications.NotificationException

Credits

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

Adel Atallah
Guillaume Delhumeau
Simon Urli
Thomas Mortagne
Vincent Massol

Tags:
   

Get Connected