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.

<insert description of release here>

New and Noteworthy (since XWiki 8.1 Milestone 1)

Full list of issues fixed and Dashboard for <version>.

Documents Macro Improvement

The Documents Macro now supports a location parameter to display all documents having their full reference matching the location value. 

For example:

Gives:

RSS Macro Improvements

The RSS Macro now supports feeds delivered over HTTPS. Additionally, it now uses its own user-agent string, XWiki/VERSION, where VERSION is the version of XWiki in use.

Miscellaneous

• The Document Tree Macro has a new parameter to limit the number of child nodes displayed when a parent node is expanded for the first time.

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

For Developers

Standard java.lang.Package properties

The following properties are now automatically added to all Maven jar modules MANIFEST files:

And can be accessed using java.lang.Package from any class. For example:

Deprecated and Retired projects

<description of deprecated and retired projects>

Upgrades

The following dependencies have been upgraded:

• Infinispan 8.2.1
• slf4j 1.7.21
• commons-compress 1.11
• Bootstrap 3.3.6
• JGroups 3.6.9

Miscellaneous

• The default LiveTable results page (XWiki.LiveTableResults, the page that generates the JSON displayed by the LiveTable) now supports a location extra parameter.
• Modified WebJars URL format and added some new Script Service methods:
  public String url(String webjarId, String namespace, String path, Map<String, ?> params)
  public String url(String webjarId, String namespace, String path)

Translations

The following translations have been updated: 

• Language
• Language

Tested Browsers & Databases

Performances tests compared to <last super stable version>

<a summary of the comparison with latest super stable version>

More details on <link to the test report>.

Known issues

• Bugs we know about

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.

Issues specific to XWiki XWiki 8.1 Milestone 2

• The WebJars URL format has been modified to support relative WebJars URL in subwikis. The new format is /webjars/<namespace>/<path/to/resource>?.... Reminder: you should not use this format directly and instead you should use the Script Service to generate a valid WebJars URL; this isolate you from any URL change. Example from Velocity: $services.webjars.url(...).

API Breakages

The following APIs were modified since XWiki 8.0:

• ? return type makes signature more complex for nothing
  • Violation type:
    java.method.returnTypeTypeParametersChanged
  • Code:
    ## Old:
    method java.util.List<? extends org.xwiki.extension.ExtensionDependency> org.xwiki.extension.AbstractExtension::getDependencies()
    
    ## New:
    method java.util.List<org.xwiki.extension.ExtensionDependency> org.xwiki.extension.AbstractExtension::getDependencies()
• ? return type makes signature more complex for nothing
  • Violation type:
    java.method.returnTypeTypeParametersChanged
  • Code:
    ## Old:
    method java.util.Collection<? extends org.xwiki.extension.ExtensionDependency> org.xwiki.extension.Extension::getDependencies()
    
    ## New:
    method java.util.Collection<org.xwiki.extension.ExtensionDependency> org.xwiki.extension.Extension::getDependencies()
• ? return type makes signature more complex for nothing
  • Violation type:
    java.method.returnTypeTypeParametersChanged
  • Code:
    ## Old:
    method java.util.Collection<? extends org.xwiki.extension.ExtensionDependency> org.xwiki.extension.wrap.WrappingExtension<E extends org.xwiki.extension.Extension>::getDependencies()
    
    ## New:
    method java.util.Collection<org.xwiki.extension.ExtensionDependency> org.xwiki.extension.wrap.WrappingExtension<E extends org.xwiki.extension.Extension>::getDependencies()
• ? return type makes signature more complex for nothing
  • Violation type:
    java.method.returnTypeTypeParametersChanged
  • Code:
    ## Old:
    method java.util.List<? extends org.xwiki.extension.ExtensionDependency> org.xwiki.extension.AbstractExtension::getDependencies()
    
    ## New:
    method java.util.List<org.xwiki.extension.ExtensionDependency> org.xwiki.extension.AbstractExtension::getDependencies()
• ? return type makes signature more complex for nothing
  • Violation type:
    java.method.returnTypeTypeParametersChanged
  • Code:
    ## Old:
    method java.util.Collection<? extends org.xwiki.extension.ExtensionDependency> org.xwiki.extension.Extension::getDependencies()
    
    ## New:
    method java.util.Collection<org.xwiki.extension.ExtensionDependency> org.xwiki.extension.Extension::getDependencies()
• ? return type makes signature more complex for nothing
  • Violation type:
    java.method.returnTypeTypeParametersChanged
  • Code:
    ## Old:
    method java.util.Collection<? extends org.xwiki.extension.ExtensionDependency> org.xwiki.extension.wrap.WrappingExtension<E extends org.xwiki.extension.Extension>::getDependencies()
    
    ## New:
    method java.util.Collection<org.xwiki.extension.ExtensionDependency> org.xwiki.extension.wrap.WrappingExtension<E extends org.xwiki.extension.Extension>::getDependencies()