Skip to Content
Last modified by Ilie Andriuta on 2025/04/08
Show last authors
1 {{velocity}}
2 #if ($doc.getValue('released') != 1)
3 {{warning}}This version has not yet been released.{{/warning}}
4 #end
5 {{/velocity}}
6
7 {{velocity}}
8 #set ($rnObject = $doc.getObject('ReleaseNotes.Code.ReleaseNoteClass'))
9 #set ($product = $rnObject.product)
10 #set ($version = $rnObject.version)
11 #set ($versionPrefix = $stringtool.substringBefore($version, '-'))
12 #set ($versionParts = $stringtool.split($versionPrefix, '.'))
13 #set ($isRC = $version.contains('rc'))
14 #set ($isFinal = !$isRC)
15 #set ($isFirstFinal = $versionParts[2] == 0 && $isFinal)
16 #set ($isBugFix = $versionParts[2] > 0 && $isFinal)
17 {{/velocity}}
18
19 {{box cssClass="floatinginfobox" title="**Contents**"}}
20 {{toc/}}
21 {{/box}}
22
23 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.
24
25 This release makes it possible for users with just edit right to re-order pages in the navigation, fixes bugs and improves the performance of XWiki in particular for larger instances. This release contains security fixes, with the [[highest severity being 8.7/10>>doc:dev:Community.SecurityPolicy.WebHome||anchor="HSeverity"]].
26
27 {{velocity}}
28 {{jiraBlockersFor version="$version" id="xwikiorg"/}}
29 {{/velocity}}
30
31 = New and Noteworthy (since {{velocity}}$product{{/velocity}} 17.1.0) =
32
33 [[Full list of issues fixed and Dashboard for 17.2.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15995]].
34
35 {{velocity}}
36 #if ($isBugFix)
37 {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}}
38 resolution = Fixed AND component != "Development Issues only" and component != "Development Issues only - Test" AND project in (XCOMMONS, XRENDERING, XWIKI) AND fixVersion in ($version)
39 {{/jira}}
40 #else
41 {{releasenotechanges/}}
42 #end
43 {{/velocity}}
44
45 === Upgrades ===
46
47 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]]):
48
49 {{velocity}}
50 #if ($isFirstFinal)
51 #set ($affectedVersions = "${version}-rc-1, ${version}")
52 #else
53 #set ($affectedVersions = "${version}")
54 #end
55 {{jira url="https://jira.xwiki.org" source="jql" style="list"}}
56 project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in ($affectedVersions) AND component = "Dependency Upgrades"
57 {{/jira}}
58 {{/velocity}}
59
60 = Translations =
61
62 The following translations have been updated:
63
64 {{language codes="es, fr, zh, zh_TW"}}{{/language}}
65
66 = Tested Browsers & Databases =
67
68 == Automated testing ==
69
70 XWiki executes a lot of [[automated tests during its build>>dev:Community.Testing.WebHome||anchor="HTestingStrategy"]], testing all [[supported configurations>>dev:Community.SupportStrategy.WebHome]]. In addition, some manual QA is also executed to try to discover additional problems (see below):
71
72 {{include reference="TestReports.ManualTestReportSummaryXWiki1720.WebHome"/}}
73
74 {{comment}}
75 TODO: uncomment and update with proper links when the report is ready.
76
77 = Performances tests compared to <last super stable version> =
78
79 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
80
81 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
82 {{/comment}}
83
84 = Security Issues =
85
86 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.
87
88 = Accessibility =
89
90 We are working towards [[WCAG 2.2>>https://developer.mozilla.org/en-US/docs/Web/Accessibility/Understanding_WCAG]] level AA compliance.
91
92 Current status:
93
94 * A total of **414985** automated tests are run.
95 * **99.63%** of our automated WCAG tests are passing. There are **22** warnings left in the tests to fix (< 0.01%) and **1495** incomplete tests (0.35%). By "incomplete", it means that they need manual validation.
96 ** Note that the automated WCAG tests have 2 limitations: WCAG tests are executed only for UIs for which we have automated functional tests available, and the underlying library we use for testing (Axe Core) estimates that it catches only about 50% of WCAG issues. We plan to continue running regularly some manual WCAG tests in addition to all these automated tests.
97 ** Out of the **61** rules automatically tested on XWiki, only **3** of them return warnings. All the other tests will fail the build if violated in the future.
98 ** The three types of violations found in automated tests currently are:
99 *** [[XWIKI-21584: Mentions do not have enough contrast>>https://jira.xwiki.org/browse/XWIKI-21584]]
100 *** [[XWIKI-20909: Code macro scroll controls are not keyboard accessible>>https://jira.xwiki.org/browse/XWIKI-20909]]
101 *** [[XWIKI-20996: AWM entry edit forms don't have labels>>https://jira.xwiki.org/browse/XWIKI-20996]]
102 * Remaining accessibility violations can be seen on this [[filter result table>>url:https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15396#Filter-Results/20051]].
103 * The progress of fixing accessibility issues vs raising them can be seen on this [[status chart>>url:https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15396#Created-vs-Resolved-Chart/20019]].
104
105 = Known issues =
106
107 * [[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]]
108
109 = Backward Compatibility and Migration Notes =
110
111 == General Notes ==
112
113 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
114 ** ##xwiki.cfg##
115 ** ##xwiki.properties##
116 ** ##web.xml##
117 ** ##hibernate.cfg.xml##
118 * 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.
119
120 == Issues specific to {{velocity}}$product $version{{/velocity}} ==
121
122 === Protection against concurrent modification of cached document ===
123
124 It's considered bad practice to directly modify the document from the cache (mainly because it can badly impact other requests/threads). This version introduces automatic protections to avoid this situation as much as possible by doing the following: if the XWikiDocument instance in the document store has been modified, any attempt to access it will result in the reloading of the document from the store and the replacement of the "corrupted" document from the cache.
125
126 But also a warning is logged when the mistake is made so that the related code is identified and fixed, because the protection cannot fix all cases. To avoid the warning, one must clone the XWikiDocument before modifying it. That's something that has already been done automatically for a long time when using the Document script API.
127 It would be great to report those warnings if you encounter any, but it's also possible to disable them easily because they are considered deprecation logs: control them using the property ##logging.deprecated.enabled## in the ##xwiki.properties## configuration file.
128
129 == API Breakages ==
130
131 The following APIs were modified since {{velocity}}$product{{/velocity}} 17.1.0:
132
133 {{velocity}}
134 {{backwardCompatibilityReport134 version="$version"/}}
135 {{/velocity}}
136
137 = Credits =
138
139 The following people have contributed code and translations to this release (sorted alphabetically):
140
141 * Alex Cotiugă
142 * Alvaro
143 * Anmol
144 * Gankov Andrey
145 * LEE CHENG WEI
146 * LucasC
147 * Manuel Leduc
148 * Marius Dumitru Florea
149 * Michael Hamann
150 * Simon Urli
151 * Thomas Mortagne
152 * Vincent Massol
153 * slauriere
154 * zon1002

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected