Release Notes for XWiki 12.10.4

Version 10.3 by Vincent Massol on 2021/02/10

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, including two blockers, that we have discovered since XWiki 12.10.3 has been released.

New and Noteworthy (since XWiki 12.10.3)

Dashboard for XWiki 12.10.4.

Upgrades

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

Translations

The following translations have been updated:

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 12.10.3:

  • Unstable API: don't serialize unset fields to JSON
    • Violation type:
      java.annotation.added
    • Code:
      ## Old:
      class org.xwiki.livedata.LiveDataActionDescriptor

      ## New:
      class org.xwiki.livedata.LiveDataActionDescriptor
  • Unstable API: moved to edit action descriptor
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method java.lang.String org.xwiki.livedata.LiveDataEntryDescriptor::getAllowEditProperty()
  • Unstable API: moved to edit action descriptor
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method void org.xwiki.livedata.LiveDataEntryDescriptor::setAllowEditProperty(java.lang.String)
  • Unstable API: replaced by 'save'
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method java.util.Optional<java.lang.Object> org.xwiki.livedata.LiveDataEntryStore::add(java.util.Map<java.lang.String, java.lang.Object>) throws org.xwiki.livedata.LiveDataException
  • Unstable API: moved to entry descriptor
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method java.lang.String org.xwiki.livedata.LiveDataEntryStore::getIdProperty()
  • Unstable API: replaced by 'save'
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method java.util.Optional<java.lang.Object> org.xwiki.livedata.LiveDataEntryStore::update(java.util.Map<java.lang.String, java.lang.Object>) throws org.xwiki.livedata.LiveDataException
  • Unstable API: replaced by 'save'
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method boolean org.xwiki.livedata.LiveDataPropertyDescriptorStore::add(org.xwiki.livedata.LiveDataPropertyDescriptor) throws org.xwiki.livedata.LiveDataException
  • Unstable API: replaced by 'save'
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method boolean org.xwiki.livedata.LiveDataPropertyDescriptorStore::update(org.xwiki.livedata.LiveDataPropertyDescriptor) throws org.xwiki.livedata.LiveDataException
  • Unstable API: Use the default LiveDataConfigurationResolver instead
    • Violation type:
      java.method.removed
    • Code:
      ## Old:
      method org.xwiki.livedata.LiveDataPropertyDescriptorStore org.xwiki.livedata.LiveDataSource::getPropertyTypes()
  • Not breaking: this annotation should not be used anymore.
    • Violation type:
      java.annotation.removed
    • Code:
      ## Old:
      method void org.xwiki.security.authentication.script.AuthenticationScriptService::resetAuthenticationFailureCounter(java.lang.String)

      ## New:
      method void org.xwiki.security.authentication.script.AuthenticationScriptService::resetAuthenticationFailureCounter(java.lang.String)

Credits

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

  • ClemDee
  • ClĂ©ment
  • Manuel Leduc
  • Marius Dumitru Florea
  • Simon Urli
  • Thomas Mortagne
  • Vincent Massol
Tags:
   

Get Connected