Release Notes for XWiki 10.7-rc-1

Last modified by Adel Atallah on 2018/09/03

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.

One of the main focus of XWiki 10.7 was bug fixing thus this release starts by reducing the bug count by 30, in important areas such as as Notifications, Skin or the core. This version also contains the beginning of replacing the old XWiki Confirmation boxes with Bootstrap modals with a focus on the comments action box to start with.

The 1.24 version of the CKEditor Integration bundled with this release has an important regression (CKEDITOR-219). We recommend upgrading CKEditor Integration to the latest version that fixes the problem.

An important bug has been discovered since XWiki 10.7 has been released:

You should wait for the next version of XWiki that will be released soon!

This release contains a bug that can affect the scalability of the service. Until the proper fix, it is highly recommended to make sure that the "autowatch" feature of the notifications is turned off. Note that starting with XWiki 10.7 (10.7RC1 to be precise), "autowatch" is turned off by default.
 
You can do that by adding in the xwiki.properties file the following lines:

# Disable autowatch until the following issue is fixed:
# https://jira.xwiki.org/browse/XWIKI-15445
xwiki.plugin.watchlist.automaticwatch=none

New and Noteworthy (since XWiki 10.6.1)

Full list of issues fixed and Dashboard for 10.7.

For Users

Link Autocomplete in WYSIWYG Editor


You can now create links to existing wiki pages and attachments directly from the editing area using the link auto-complete feature. Just type [ (open square bracket) followed by at least 2 characters and you will get link suggestions based on the typed text. Checkout the CKEditor Integration documentation for more information.

Macro Content Prefill in WYSIWYG Editor


When inserting a macro, the macro content text area is prefilled with the text selected within the editing area. This means you can for instance transform a paragraph into an error message by selecting the paragraph text, click the Insert Macro button from the tool bar, select the Error Message macro and insert it. Checkout the CKEditor Integration documentation for more information.

Updated the comments modals


The comments pop-ups that are displayed for deleting a comment and for permalink are now bootstrap modals, having the same functionality as before.

Miscellaneous

  • Removed misleading shortcut: Removed the META+V shortcut used in the jump dialog as it was preventing users from pasting.

For Admins

External URL generation improvements


It's now possible to set the port to use when generating an URL for a wiki in the each wiki descriptor. When the port is not set for a wiki, XWiki fallback on the main wiki descriptor.

Subwiki secure property (which indicate if HTTPS should be used instead of HTTP when generating a URL for the wiki) now inherit main wiki value if not explicitly set.

The first time XWiki is accessed the main wiki descriptor is generated using what can be found in the request's URL. For example if you access your wiki using https:mydomain:9898/xwiki/ you will end up with the following main wiki descriptor:

  • alias: mydomain
  • secure: true
  • port: 9898

Also XWiki now supports the Forwarded (RFC7239) standard HTTP header when extracting information from the URL used by the client.

Miscellaneous

For Developers

No changes!

Upgrades

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

Translations

We recently moved l10n.xwiki.org to a new translation platform based on Weblate and we're still trying to figure out how to compute an accurate list of the locales that have been updated for real (excluding comments and whitespace changes). We hope to put back the list of updated translations in the next release notes.

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 68Not Tested
Firefox30.pngMozilla Firefox 61Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
Edge30.pngMicrosoft Edge 17Smoke tests
IE30.pngInternet Explorer 11Smoke tests
Safari30.pngSafari 11.1Not 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.1Not Tested
mysql.pngMySQL 5.7Smoke tests
oracle.pngOracle 11.2Jira Tickets Marked as Fixed in the Release Notes + New and Noteworthy Features
postgresql.pngPostgreSQL 10Smoke tests

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.

Issues specific to XWiki 10.7RC1

URL generation modifications

In most cases there is nothing to do but for some edge cases it's possible that you end up with external URL having a different port than the one you expect.

If that's the case the recommendation is to go to the main wiki descriptor and make sure it contains the port you want to see in those URLs (don't put anything if you just want to use the default port implied by the protocol) and to explicitly set the secure property. Since xwiki.url.protocol from xwiki.cfg configuration file is not really needed anymore tt's also recommended to stop using it only rely on the wiki descriptor(s) which are easier to control.

API Breakages

The following APIs were modified since XWiki 10.6.1:

  • Not a breakage.
    • Violation type:
      java.annotation.attributeValueChanged
    • Code:
      ## Old:
      @interface org.xwiki.stability.Unstable

      ## New:
      @interface org.xwiki.stability.Unstable
  • Not a breakage: class moved to a legacy module
    • Violation type:
      java.class.removed
    • Code:
      ## Old:
      class org.xwiki.velocity.introspection.AbstractChainableUberspector
  • Not a breakage: class moved to a legacy module
    • Violation type:
      java.class.removed
    • Code:
      ## Old:
      interface org.xwiki.velocity.introspection.ChainableUberspector
  • Not a breakage: class moved to a legacy module
    • Violation type:
      java.class.removed
    • Code:
      ## Old:
      class org.xwiki.velocity.introspection.ChainingUberspector
  • Not a breakage: class moved to a legacy module
    • Violation type:
      java.class.removed
    • Code:
      ## Old:
      class org.xwiki.velocity.introspection.LinkingUberspector
  • Adding a REST endpoint is actually not an API breakage.
    • Violation type:
      java.method.addedToInterface
    • Code:
      ## Old:
      null

      ## New:
      method java.lang.String org.xwiki.notifications.rest.NotificationsResource::getNotificationsRSS(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) throws java.lang.Exception
  • Not a breake: the REST endpoint is the same.
    • Violation type:
      java.method.returnTypeChanged
    • Code:
      ## Old:
      method org.xwiki.notifications.rest.model.Notifications org.xwiki.notifications.rest.NotificationsResource::getNotifications(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) throws java.lang.Exception

      ## New:
      method javax.ws.rs.core.Response org.xwiki.notifications.rest.NotificationsResource::getNotifications(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) throws java.lang.Exception
  • Young API
    • Violation type:
      java.method.addedToInterface
    • Code:
      ## Old:
      null

      ## New:
      method org.xwiki.notifications.filters.watch.AutomaticWatchMode org.xwiki.notifications.filters.watch.WatchedEntitiesConfiguration::getDefaultAutomaticWatchMode(org.xwiki.model.reference.WikiReference)

Credits

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

Adel Atallah
Alex Cotiugă
Andrei C
Clément Aubin
Constantin Listar
Ecaterina Moraru (Valica)
Guillaume Delhumeau
Marius Dumitru Florea
Oana-Lavinia Florean
Thomas Mortagne
Valdis Vitolins
Vincent Massol
吴国凯

Tags:
Created by Adel Atallah on 2018/08/03
   

Get Connected