Release Notes for XWiki 5.4 Milestone 1

Last modified by Thomas Mortagne on 2017/03/24

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

This is an improvement and stability release for things started during the 5.x cycle.

A few hours after the release was done we've realized that this version contains a bug that makes it not usable as is: it's missing 2 important pages: XWiki.XWikiAdminGroup and XWiki.XWikiAllGroup. If you plan to use this version make sure you import those 2 pages from this XWiki 5.3 XAR for example. Otherwise please use XWiki 5.4 RC1 or later.

It also seems upgrade from a previous version to this one is broken (some that are deleted while they should not). See the issue for details.

New and Noteworthy (since XWiki 5.3)

Full list of issues fixed and Dashboard for XWiki 5.4.

WikiStream improvements

  • added support for file:<path> syntax in source and target properties wikistream-target.png
  • instance input module is now able to generate generic revision events
  • Confluence input module pass page content as it is when target does not support rendering events (instead of nothing)

XWiki Repository updated

A few changes that were applied on http://extensions.xwiki.org since a long time were not applied on git repository, this is now fixed.

Miscellaneous

  • Added support for creating and deleting wikis when using the H2 database.
  • Extension Manager XAR handler now compare attachments content (but does not merge them) and save them in the same version than the document itself

See the full list of JIRA issues fixed in this release.

For Developers

Miscellaneous

  • Properties annotations (@PropertyName, @PropertyDescription, etc.) are now now annotated with @Inherited which make possible to define them in interfaces or abstracts for example
  • It's now possible to use plugins installed as extension (only if installed or either main wiki or farm)
  • It's now possible to specify a custom version for the distribution UI in the WAR pom.xml using xwiki.extension.distribution.ui.version and xwiki.extension.distribution.wikiui.version.
  • New Document.getLocale() API which should be used rather than the older Document.getLanguage() which is now deprecated.
  • It's now possible to organize the slf4j log as a tree, see Logging Module.
  • The XWiki.XWikiAdminGroup and XWiki.XWikiAllGroup pages have been moved from the xwiki-platform-administration-ui module to the xwiki-enterprise-ui-admin-user one.

Upgrades

The following dependencies have been upgraded:

Translations

The following translations have been updated: 

Tested Browsers & Databases

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

BrowserStatus
Chrome30.pngGoogle Chrome 31Jira Tickets Marked as Fixed in the Release Notes
Firefox30.pngMozilla Firefox 26Not Tested
IE30.pngInternet Explorer 8Not Tested
IE30.pngInternet Explorer 9Not Tested

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

DatabaseStatus
hypersql.pngHyperSQL 2.3.1Jira Tickets Marked as Fixed in the Release Notes
mysql.pngMySQL 5.6.10Not Tested
oracle.pngOracle 11.2Not Tested
postgresql.pngPostgreSQL 9.2.4Not Tested

For the full list of tests see this page.

Known issues

Backward Compatibility and Migration Notes

General Notes

When upgrading make sure you compare your xwiki.cfg, xwiki.properties and web.xml files with the newest version since some configuration parameters may have been modified or added. Note that you should add xwiki.store.migration=1 so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

API Breakages

The following APIs were modified since 5.3:

org.xwiki.wikistream.xar.input.XARInputProperties: Method 'public boolean isReferencesOnly()' has been removed
org.xwiki.wikistream.xar.input.XARInputProperties: Method 'public void setReferencesOnly(boolean)' has been removed
org.xwiki.wikistream.model.filter.WikiDocumentFilter: Field PARAMETER_REVISION has been removed, but it was previously a constant
org.xwiki.wikistream.model.filter.WikiObjectPropertyFilter: Parameter 2 of 'public void onWikiObjectProperty(java.lang.String, java.lang.String, org.xwiki.filter.FilterEventParameters)' has changed its type to java.lang.Object

Get Connected