Skip to Content
Version 10.1 by Manuel Leduc on 2025/01/28
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.size() == 2 && $isFinal)
16 #set ($isBugFix = $versionParts.size() == 3 && $versionParts[2] > 0)
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 is the first release of the 17.x cycle. The most notable change is the move to Jakarta EE 9.1 that allows XWiki to run on recent versions of the supported application servers (like Tomcat 10+ and Jetty 12 EE9/10). Make sure to read the migration notes though since this change can potentially break backwards compatibility. Besides this, it's worth mentioning the new sort parameter for the Document Tree and Children macros, and the new notification email headers for auto-replies. Being the start of a new cycle we also took the opportunity to upgrade of a lot of our dependencies.
26
27 This release contains security fixes, with the [[highest severity being 8.7/10>>url:https://dev.xwiki.org/xwiki/bin/view/Community/SecurityPolicy/#HSeverity]].
28
29 {{comment}}
30 Uncomment when there's at least one issue listed in the table!
31 {{error}}
32 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.
33
34 {{velocity}}
35 #if ($isFirstFinal)
36 #set ($affectedVersions = "${version}-rc-1, ${version}")
37 #set ($fixVersionJQL = " and (fixVersion != ${version}-rc-1 or fixVersion is empty)")
38 #else
39 #set ($affectedVersions = "${version}")
40 #set ($fixVersionJQL = "")
41 #end
42 {{jira id="xwikiorg" source="jql"}}
43 category = 10000 and affectedVersion in ($affectedVersions)${fixVersionJQL}and priority = Blocker and resolution in (Fixed, Unresolved) and component != "Development Issues only"
44 {{/jira}}
45 {{/velocity}}
46 {{/error}}
47 {{/comment}}
48
49 = New and Noteworthy (since {{velocity}}$product{{/velocity}} 16.10.2) =
50
51 [[Full list of issues fixed and Dashboard for 17.0.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15890]].
52
53 {{velocity}}
54 #if ($isBugFix)
55 {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}}
56 resolution = Fixed AND component != "Development Issues only" and component != "Development Issues only - Test" AND project in (XCOMMONS, XRENDERING, XWIKI) AND fixVersion in ($version)
57 {{/jira}}
58 #else
59 {{releasenotechanges/}}
60 #end
61 {{/velocity}}
62
63 === Moved Modules ===
64
65 * ##org.xwiki.platform:xwiki-platform-container-portlet## was moved to https://github.com/xwiki-attic/xwiki-platform-container-portlet
66
67 === Upgrades ===
68
69 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]]):
70
71 {{jira url="https://jira.xwiki.org" source="jql" style="list"}}
72 project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in (17.0.0-rc-1, 17.0.0) AND component = "Dependency Upgrades"
73 {{/jira}}
74
75 = Translations =
76
77 The following translations have been updated:
78
79 {{language codes="zh"}}{{/language}}
80
81 {{comment}}
82 TODO: uncomment and update with proper link when the report is ready.
83
84 = Tested Browsers & Databases =
85
86 {{include reference="TestReports.<test report page>"/}}
87 {{/comment}}
88
89 {{comment}}
90 TODO: uncomment and update with proper links when the report is ready.
91
92 = Performances tests compared to <last super stable version> =
93
94 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
95
96 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
97 {{/comment}}
98
99 = Security Issues =
100
101 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.
102
103 = Known issues =
104
105 * [[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]]
106
107 = Backward Compatibility and Migration Notes =
108
109 == General Notes ==
110
111 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
112 ** ##xwiki.cfg##
113 ** ##xwiki.properties##
114 ** ##web.xml##
115 ** ##hibernate.cfg.xml##
116 * 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.
117
118 == Issues specific to {{velocity}}$product $version{{/velocity}} ==
119
120
121 === Move to Jakarta EE 9.1 ===
122
123 XWiki has been migrated to Jakarta EE 9.1 specification.
124
125 The most notable change is that it means it now requires corresponding application servers: Tomcat 10+ and Jetty 11+ for example.
126 But the biggest difference between Jakarta EE 8 and 9.x is the move from ##javax.*## to ##jakarta.*## packages, so this migration commes with some potential breakages:
127
128 * Servlet 5 (##javax.servlet## -> ##jakarta.servlet##): XWiki comes with a bridge that should make the upgrade transparent from extensions, it mainly means that a lot of Servlet related API is now deprecated and application authors should move to new ones, most notably all the request related APIs from xwiki-platform-oldcore are replaced by ##org.xwiki.container.Container## based APIs. Also XWiki is now doing its best (in Jetty and Tomcat only right now) by default to enable everything it can find to allow any character in URLs at init, it's possible to disable this using the property ##url.forceAllowAnyCharacter## in the ##xwiki.properties## configuration file (but it will most probably prevent some XWiki features to work property, see [[XWIKI-19167>>https://jira.xwiki.org/browse/XWIKI-19167]] for more details)
129 * WebSocket 2.1 (##javax.websocket## -> ##jakarta.websocket##): there is no bridge here. If you were directly manipulating ##javax.websocket## APIs, you will have to move to jakarta.websocket and all XWiki APIs that were exposing ##javax.websocket## have been modified to expose the ##jakarta.websocket## versions.
130 * Validation 3: there is no bridge either here, so you have to move to the ##jakarta.validation## versions of the annotations. Since Jakarta Validation is only annotations, you can actually use both at the same time if you want to support different versions of XWiki in your extension for example.
131
132 Move ##javax.*## to ##jakarta.*## migration will happen in the course of the 17.x XWiki cycle. See [[design:Proposal.Jakartamigration]] for more details about that.
133
134 === Redirect behavior changes ===
135
136 * [[Trusted domains>>Documentation.AdminGuide.Configuration||anchor="HTrusteddomains"]] are checking for all redirect called in XWiki now, it used to be only code going through XWikiRequest.
137 * By default relative redirect are now resolved by XWiki instead of the application server. The goal was to reduce the configuration need (XWiki has all the information to properly resolve the redirect and the application server sometimes require some more setup), but if this change cause problem you can move back to using the application server using the property ##container.request.resolveRelativeRedirect## in the ##xwiki.properties## configuration file.
138
139 === CSS name changed in xwiki-platform-notifications-webjar ===
140
141 [[Due to an upgrade of vite package>>https://jira.xwiki.org/browse/XWIKI-22793]] used for building ##xwiki-platform-notifications-webjar## the CSS file generated is now named ##main.css## instead of ##style.css##. Pay attention to use that new name for loading the file starting with XWiki 17.0.0.
142
143
144 == API Breakages ==
145
146 The following APIs were modified since {{velocity}}$product{{/velocity}} 16.10.2:
147
148 {{velocity}}
149 {{backwardCompatibilityReport134 version="$version"/}}
150 {{/velocity}}
151
152 = Credits =
153
154 The following people have contributed code and translations to this release (sorted alphabetically):
155
156 * Cye3s
157 * Lucas C
158 * Manuel Leduc
159 * Marius Dumitru Florea
160 * Maximilien Cuony
161 * Michael Hamann
162 * Nikita Petrenko
163 * Simon Urli
164 * Simpel
165 * Thomas Mortagne
166 * Vincent Massol
167 * jasongwq
168 * xrichard

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected