Skip to Content

Version 3.1 by Simon Urli on 2024/05/22
Show last authors
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
18 <insert description of release here>
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
40 = New and Noteworthy (since {{velocity}}$product{{/velocity}} 16.3.1) =
41
42 [[Full list of issues fixed and Dashboard for XWiki 16.4.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=15714]].
43
44 {{releasenotechanges/}}
45
46 === Moved Modules ===
47
48 <description deprecated, retired and moved projects>
49
50 === Upgrades ===
51
52 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]]):
53
54 * [[JBoss Logging 3.6.0>>https://jira.xwiki.org/browse/XCOMMONS-3023]]]
55 * [[bytebuddy 1.14.15>>https://jira.xwiki.org/browse/XCOMMONS-3010]]]
56 * [[AspectJ 1.9.22.1>>https://jira.xwiki.org/browse/XCOMMONS-3025]]]
57 * [[Jackson 2.17.1>>https://jira.xwiki.org/browse/XCOMMONS-3022]]]
58 * [[Commons CSV 1.11.0>>https://jira.xwiki.org/browse/XCOMMONS-3017]]]
59 * [[Guava 33.2.0-jre>>https://jira.xwiki.org/browse/XCOMMONS-3018]]]
60 * [[Checker Qual 3.43.0>>https://jira.xwiki.org/browse/XCOMMONS-3019]]]
61 * [[Error Prone annotations 2.27.1>>https://jira.xwiki.org/browse/XCOMMONS-3009]]]
62 * [[Maven Resolver to 1.9.20>>https://jira.xwiki.org/browse/XCOMMONS-3004]]]
63 * [[Commons Codec 1.17.0>>https://jira.xwiki.org/browse/XCOMMONS-3008]]]
64 * [[Bouncy Castle 1.78.1>>https://jira.xwiki.org/browse/XCOMMONS-3014]]]
65 * [[Commons CLI 1.7.0>>https://jira.xwiki.org/browse/XCOMMONS-3015]]]
66 * [[JGroups 5.3.6>>https://jira.xwiki.org/browse/XCOMMONS-3016]]]
67
68 = Translations =
69
70 The following translations have been updated:
71
72 {{language codes="none, none"/}}
73
74 {{comment}}
75 TODO: uncomment and update with proper link when the report is ready.
76
77 = Tested Browsers & Databases =
78
79 {{include reference="TestReports.<test report page>"/}}
80 {{/comment}}
81
82 {{comment}}
83 TODO: uncomment and update with proper links when the report is ready.
84
85 = Performances tests compared to <last super stable version> =
86
87 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
88
89 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
90 {{/comment}}
91
92 = Security Issues =
93
94 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.
95
96 = Known issues =
97
98 * [[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]]
99
100 = Backward Compatibility and Migration Notes =
101
102 == General Notes ==
103
104 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
105 ** ##xwiki.cfg##
106 ** ##xwiki.properties##
107 ** ##web.xml##
108 ** ##hibernate.cfg.xml##
109 * 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.
110
111 == Issues specific to {{velocity}}$product $version{{/velocity}} ==
112
113 <issues specific to the project>
114
115 == API Breakages ==
116
117 The following APIs were modified since {{velocity}}$product{{/velocity}} <version - 1>:
118
119 {{comment}}
120 Remove!
121 {{velocity}}
122 {{backwardCompatibilityReport134 version="$version"/}}
123 {{/velocity}}
124 {{/comment}}
125
126 = Credits =
127
128 The following people have contributed code and translations to this release (sorted alphabetically):
129
130 <code and translation contributors>

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected