Last modified by Ilie Andriuta on 2024/03/21

Hide last authors
Manuel Leduc 1.1 1 {{velocity}}
2 #set ($rnObject = $doc.getObject('ReleaseNotes.Code.ReleaseNoteClass'))
3 #set ($product = $rnObject.product)
4 #set ($version = $rnObject.version)
5 #set ($versionPrefix = $stringtool.substringBefore($version, '-'))
6 #set ($versionParts = $stringtool.split($versionPrefix, '.'))
7 #set ($isRC = $version.contains('rc'))
8 #set ($isFinal = !$isRC)
9 #set ($isFirstFinal = $versionParts.size() == 2 && $isFinal)
10 {{/velocity}}
11
12 {{box cssClass="floatinginfobox" title="**Contents**"}}
13 {{toc/}}
14 {{/box}}
15
16 This is the release notes for [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]] and [[XWiki Platform>>http://platform.xwiki.org]]. They share the same release notes as they are released together and have the same version.
17
Vincent Massol 18.1 18 The realtime WYSIWYG editing feature has been added to XWiki (but turned off by default as it's still considered experimental). In addition this release brings performance improvements when pages have lots of revisions. In term of important infrastructure changes, XWiki has moved from Restlet to Jersey for its REST API and from Solr 8 to Solr 9 (a migration has been included). XWiki is progressing on its path for being WCAG 2.1 AA compliant and several improvements have been made. And bug fixes as usual.
Manuel Leduc 1.1 19
20 {{comment}}
21 Uncomment when there's at least one issue listed in the table!
22 {{error}}
23 The following regressions were introduced in this release (and found after it was released). Please check them out and if they impact you we recommend waiting to upgrade to a version where they are fixed.
24
25 {{velocity}}
26 #if ($isFirstFinal)
27 #set ($affectedVersions = "${version}-rc-1, ${version}")
28 #set ($fixVersionJQL = " and (fixVersion != ${version}-rc-1 or fixVersion is empty)")
29 #else
30 #set ($affectedVersions = "${version}")
31 #set ($fixVersionJQL = "")
32 #end
33 {{jira id="xwikiorg" source="jql"}}
34 category = 10000 and affectedVersion in ($affectedVersions)${fixVersionJQL}and priority = Blocker and resolution in (Fixed, Unresolved) and component != "Development Issues only"
35 {{/jira}}
36 {{/velocity}}
37 {{/error}}
38 {{/comment}}
39
Vincent Massol 8.1 40 = New and Noteworthy (since {{velocity}}$product{{/velocity}} 16.1.0) =
Manuel Leduc 1.1 41
Vincent Massol 8.1 42 [[Full list of issues fixed and Dashboard for 16.2.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15707]].
Manuel Leduc 1.1 43
44 {{releasenotechanges/}}
45
46 === Upgrades ===
47
48 The following runtime dependencies have been upgraded (they have a different release cycle than [[XWiki Commons>>http://commons.xwiki.org]], [[XWiki Rendering>>http://rendering.xwiki.org]] and [[XWiki Platform>>http://platform.xwiki.org]]):
49
Manuel Leduc 2.1 50 * [[dompurify 3.0.9>>https://jira.xwiki.org/browse/XWIKI-21905]]
Vincent Massol 3.1 51 * [[Jetty 10.0.20>>https://jira.xwiki.org/browse/XWIKI-21948]]
Simon Urli 5.2 52 * [[AspectJ 1.9.21.2>>https://jira.xwiki.org/browse/XCOMMONS-2939]]
53 * [[commons-compress 1.26.0>>https://jira.xwiki.org/browse/XCOMMONS-2930]]
54 * [[MariaDB connector 3.3.3>>https://jira.xwiki.org/browse/XWIKI-21937]]
55 * [[PostgresSQL connector 42.7.2>>https://jira.xwiki.org/browse/XWIKI-21936]]
56 * [[Docker Java 3.3.6>>https://jira.xwiki.org/browse/XWIKI-21917]]
57 * [[Commons Codec 1.16.1>>https://jira.xwiki.org/browse/XCOMMONS-2940]]
58 * [[Wiremock 3.4.2>>https://jira.xwiki.org/browse/XCOMMONS-2941]]
59 * [[Log4J API 2.23.0>>https://jira.xwiki.org/browse/XCOMMONS-2943]]
60 * [[Exec Maven Plugin 3.2.0>>https://jira.xwiki.org/browse/XCOMMONS-2942]]
61 * [[JGroups 5.3.4>>https://jira.xwiki.org/browse/XCOMMONS-2933]]
62 * [[Error Prone annotations 2.25.0>>https://jira.xwiki.org/browse/XCOMMONS-2935]]
Simon Urli 6.1 63 * [[SLF4J 2.0.12>>https://jira.xwiki.org/browse/XCOMMONS-2929]]
64 * [[Woodstox 6.6.1>>https://jira.xwiki.org/browse/XCOMMONS-2937]]
65 * [[MChange Commons 0.3.0>>https://jira.xwiki.org/browse/XWIKI-21934]]
66 * [[Netty 4.1.107.Final>>https://jira.xwiki.org/browse/XWIKI-21939]]
67 * [[Download Plugin for Maven 1.8.1>>https://jira.xwiki.org/browse/XWIKI-21940]]
68 * [[JFFI 1.3.13>>https://jira.xwiki.org/browse/XWIKI-21942]]
69 * [[JNR FFI 2.2.16>>https://jira.xwiki.org/browse/XWIKI-21943]]
70 * [[JNR POSIX 3.1.19>>https://jira.xwiki.org/browse/XWIKI-21941]]
71 * [[Protobuf Java 3.25.3>>https://jira.xwiki.org/browse/XCOMMONS-2936]]
Thomas Mortagne 9.1 72 * [[commons-compress 1.26.1>>https://jira.xwiki.org/browse/XCOMMONS-2959]]
73 * [[Zookeeper 3.9.2>>https://jira.xwiki.org/browse/XWIKI-21986]]
74 * [[Solr 9.4.1 and Lucene 9.8.0>>https://jira.xwiki.org/browse/XWIKI-20477]]
75 * [[Maven XML 4.0.0-alpha-13>>https://jira.xwiki.org/browse/XCOMMONS-2957]]
76 * [[Log4J API 2.23.1>>https://jira.xwiki.org/browse/XCOMMONS-2956]]
77 * [[Liquibase 4.26.0>>https://jira.xwiki.org/browse/XWIKI-21951]]
78 * [[Jetty Client 10.0.19>>https://jira.xwiki.org/browse/XWIKI-21709]]
79 * [[Jackson 2.17.0>>https://jira.xwiki.org/browse/XCOMMONS-2958]]
80 * [[JSONP 2.1.3 and Parsson 1.1.5>>https://jira.xwiki.org/browse/XCOMMONS-2945]]
81 * [[JAX-RS 2.1.6 (JSR370)>>https://jira.xwiki.org/browse/XWIKI-12955]]
82 * [[Groovy 4.0.19>>https://jira.xwiki.org/browse/XCOMMONS-2950]]
83 * [[Error Prone annotations 2.26.1>>https://jira.xwiki.org/browse/XCOMMONS-2952]]
84 * [[Elastic search client 8.12.2>>https://jira.xwiki.org/browse/XWIKI-21953]]
85 * [[Commons DBCP2 2.12.0>>https://jira.xwiki.org/browse/XCOMMONS-2948]]
86 * [[Commons Configuration 2.10.0>>https://jira.xwiki.org/browse/XCOMMONS-2960]]
87 * [[Antlr 4.13.1>>https://jira.xwiki.org/browse/XCOMMONS-2407]]
Manuel Leduc 1.1 88
89 = Translations =
90
Vincent Massol 15.1 91 The following translations have been updated:
Manuel Leduc 1.1 92
Vincent Massol 15.1 93 {{language codes="de,zh"/}}
Manuel Leduc 1.1 94
95 = Tested Browsers & Databases =
96
Ilie Andriuta 22.1 97 {{include reference="TestReports.ManualTestReportSummaryXWiki1620RC1.WebHome"/}}
Manuel Leduc 1.1 98
99 {{comment}}
100 TODO: uncomment and update with proper links when the report is ready.
101
102 = Performances tests compared to <last super stable version> =
103
104 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
105
106 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
107 {{/comment}}
108
109 = Security Issues =
110
111 Security issues are not listed in issue lists or dashboards to avoid disclosing ways to use them, but they will appear automatically in them once they're disclosed. See the [[XWiki Security Policy>>dev:Community.SecurityPolicy.WebHome]] for more details.
112
113 = Known issues =
114
115 * [[Bugs we know about>>https://jira.xwiki.org/issues/?jql=category%20%3D%2010000%20AND%20issuetype%20%3D%20Bug%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20updated%20DESC]]
116
117 = Backward Compatibility and Migration Notes =
118
119 == General Notes ==
120
121 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
122 ** ##xwiki.cfg##
123 ** ##xwiki.properties##
124 ** ##web.xml##
125 ** ##hibernate.cfg.xml##
126 * 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.
127
128 == Issues specific to {{velocity}}$product $version{{/velocity}} ==
129
Simon Urli 5.2 130 === Move to Jersey ===
Manuel Leduc 1.1 131
Vincent Massol 12.1 132 The XWiki REST API used to depend on Restlet, and has now been moved to Jersey 2.
Thomas Mortagne 3.2 133
Vincent Massol 12.1 134 We took great care to keep the same behavior as much as possible, but there are some differences:
Simon Urli 5.2 135
Vincent Massol 12.1 136 * If you were using directly any Restlet class (which was something not recommended), your code won't work anymore.
137 * There were some bugs in the Restlet implementation of the ##URIBuilder## class. They are fixed in Jersey. One that was existing when Restlet was used was that Restlet was not escaping ##/## characters contained in parameters passed to the ##URIBuilder## class. So, if your code was depending on this behavior, you are going to have problems, and you'll need to split the parameters into several Strings instead (this should work fine with Restlet too if you want to fix the issue while staying on XWiki < 16.2.0).
138 * Restlet added a lot of custom behaviors on top of JAX-RS and HTTP specifications, especially regarding the special meaning of some URL parameters. We only kept what was documented in the [[XWiki REST API>>xwiki:Documentation.UserGuide.Features.XWikiRESTfulAPI]] (the ##media## parameter, which allows overwriting the HTTP request Accept value, and the ##method## parameter, which allows to overwrite the HTTP request method, both of which are only here for retro-compatibility reasons, and we highly recommend to use standard HTTP instead).
Thomas Mortagne 3.2 139
Simon Urli 5.2 140 === Upgrade to Antlr 4.10+ ===
Thomas Mortagne 3.2 141
Vincent Massol 12.1 142 Antlr introduced a breaking change in version 4.10, which makes it impossible to run code built with a version of Antlr 4 lower than 4.10.
Thomas Mortagne 3.2 143
Simon Urli 5.2 144 === Upgrade to Solr 9 ===
Thomas Mortagne 5.1 145
Thomas Mortagne 14.1 146 XWiki now expects Solr 9 to be installed. There is nothing special to do if you use the embedded Solr server (the default, which has been moved to Solr 9) but if you have a standalone Solr server, you need to Solr 9 (Using Solr 8 with XWiki 16.2.0+ has not been tested and is not supported). There is an automatic migration of the data from Lucene 8 to 9 format but for this you need to setup new cores as explained in the [[remote Solr server instructions>>extensions:Extension.Solr Search API||anchor="HSetuparemoteSolrserver"]].
Thomas Mortagne 5.1 147
Marius Dumitru Florea 20.1 148 === Realtime WYSIWYG Editor ===
149
Marius Dumitru Florea 21.1 150 If you have previously installed the [[Realtime WYSIWYG Editor>>extensions:Extension.Realtime WYSIWYG Editor.WebHome]] extension and enabled realtime collaboration by default by changing the "Default WYSIWYG Editor" setting from the "Editing / WYSIWYG Editor" [[administration section>>extensions:Extension.Administration Application||anchor"HWYSIWYGEditors"]], then you need to revert this change and instead remove "xwiki-realtime" from the list of disabled CKEditor plugins from the same administration section.
Marius Dumitru Florea 20.1 151
152 If you haven't enabled realtime editing before but you have a custom list of disabled CKEditor plugins, then you need to add "xwiki-realtime" to that list, otherwise realtime editing will be enabled by default after you upgrade.
153
Manuel Leduc 1.1 154 == API Breakages ==
155
Vincent Massol 17.1 156 The following APIs were modified since {{velocity}}$product{{/velocity}} 16.2.0:
Manuel Leduc 1.1 157
158 {{velocity}}
159 {{backwardCompatibilityReport134 version="$version"/}}
160 {{/velocity}}
161
162 = Credits =
163
164 The following people have contributed code and translations to this release (sorted alphabetically):
165
Vincent Massol 16.1 166 * Antoine Mottier
167 * Clemens Robbenhaar
168 * Clément Aubin
169 * Lucas C
170 * Manish Krishna Kandrakota
171 * Manuel Leduc
172 * Marius Dumitru Florea
173 * Michael Hamann
174 * Oana-Lavinia Florean
175 * Pierre Jeanjean
176 * Simon Urli
177 * Thomas Mortagne
178 * Vincent Massol
179 * listeng

Get Connected