Skip to Content
Version 5.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 <insert description of release here>
26
27 {{comment}}
28 Uncomment when there's at least one issue listed in the table!
29 {{error}}
30 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.
31
32 {{velocity}}
33 #if ($isFirstFinal)
34 #set ($affectedVersions = "${version}-rc-1, ${version}")
35 #set ($fixVersionJQL = " and (fixVersion != ${version}-rc-1 or fixVersion is empty)")
36 #else
37 #set ($affectedVersions = "${version}")
38 #set ($fixVersionJQL = "")
39 #end
40 {{jira id="xwikiorg" source="jql"}}
41 category = 10000 and affectedVersion in ($affectedVersions)${fixVersionJQL}and priority = Blocker and resolution in (Fixed, Unresolved) and component != "Development Issues only"
42 {{/jira}}
43 {{/velocity}}
44 {{/error}}
45 {{/comment}}
46
47 = New and Noteworthy (since {{velocity}}$product{{/velocity}} 16.10.2) =
48
49 [[Full list of issues fixed and Dashboard for 17.0.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15890]].
50
51 {{velocity}}
52 #if ($isBugFix)
53 {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}}
54 resolution = Fixed AND component != "Development Issues only" and component != "Development Issues only - Test" AND project in (XCOMMONS, XRENDERING, XWIKI) AND fixVersion in ($version)
55 {{/jira}}
56 #else
57 {{releasenotechanges/}}
58 #end
59 {{/velocity}}
60
61 === Moved Modules ===
62
63 * ##org.xwiki.platform:xwiki-platform-container-portlet## was moved to https://github.com/xwiki-attic/xwiki-platform-container-portlet
64
65 === Upgrades ===
66
67 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]]):
68
69 {{jira url="https://jira.xwiki.org" source="jql" style="list"}}
70 project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in (17.0.0-rc-1, 17.0.0) AND component = "Dependency Upgrades"
71 {{/jira}}
72
73 = Translations =
74
75 The following translations have been updated:
76
77 {{language codes="zh"}}{{/language}}
78
79 {{comment}}
80 TODO: uncomment and update with proper link when the report is ready.
81
82 = Tested Browsers & Databases =
83
84 {{include reference="TestReports.<test report page>"/}}
85 {{/comment}}
86
87 {{comment}}
88 TODO: uncomment and update with proper links when the report is ready.
89
90 = Performances tests compared to <last super stable version> =
91
92 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
93
94 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
95 {{/comment}}
96
97 = Security Issues =
98
99 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.
100
101 = Known issues =
102
103 * [[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]]
104
105 = Backward Compatibility and Migration Notes =
106
107 == General Notes ==
108
109 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
110 ** ##xwiki.cfg##
111 ** ##xwiki.properties##
112 ** ##web.xml##
113 ** ##hibernate.cfg.xml##
114 * 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.
115
116 == Issues specific to {{velocity}}$product $version{{/velocity}} ==
117
118 <issues specific to the project>
119
120 == API Breakages ==
121
122 The following APIs were modified since {{velocity}}$product{{/velocity}} 16.10.2:
123
124 {{comment}}
125 Remove!
126 {{velocity}}
127 {{backwardCompatibilityReport134 version="$version"/}}
128 {{/velocity}}
129 {{/comment}}
130
131 = Credits =
132
133 The following people have contributed code and translations to this release (sorted alphabetically):
134
135 * Cye3s
136 * Lucas C
137 * Manuel Leduc
138 * Marius Dumitru Florea
139 * Maximilien Cuony
140 * Michael Hamann
141 * Nikita Petrenko
142 * Simon Urli
143 * Simpel
144 * Thomas Mortagne
145 * Vincent Massol
146 * jasongwq
147 * 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