Wiki source code of Release Notes for XWiki 13.1

Last modified by Simon Urli on 2023/01/17

Show last authors
1 {{velocity}}
2 #set ($version = $doc.getObject('ReleaseNotes.Code.ReleaseNoteClass').version)
3 #set ($versionPrefix = $stringtool.substringBefore($version, '-'))
4 #set ($versionParts = $stringtool.split($versionPrefix, '.'))
5 #set ($isRC = $version.contains('rc'))
6 #set ($isFinal = !$isRC)
7 #set ($isFirstFinal = $versionParts.size() == 2 && $isFinal)
8 {{/velocity}}
9
10 {{box cssClass="floatinginfobox" title="**Contents**"}}
11 {{toc/}}
12 {{/box}}
13
14 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.
15
16 Mostly a stabilization release with bugs fixes and some improvement such as a better experience when translating pages, adding the possibility to set wiki macro priorities, new URLs for resetting passwords and retrieving usernames, and ability to disable the Like feature.
17
18 {{error}}
19 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.
20
21 {{velocity}}
22 #if ($isFirstFinal)
23 #set ($affectedVersions = "${version}-rc-1, ${version}")
24 #set ($fixVersionJQL = " and fixVersion != ${version}-rc-1 ")
25 #else
26 #set ($affectedVersions = "${version}")
27 #set ($fixVersionJQL = "")
28 #end
29 {{jira id="xwikiorg" source="jql"}}
30 category = 10000 and affectedVersion in ($affectedVersions)${fixVersionJQL}and priority = Blocker and resolution in (Fixed, Unresolved)
31 {{/jira}}
32 {{/velocity}}
33 {{/error}}
34
35 = New and Noteworthy (since XWiki 13.0) =
36
37 [[Full list of issues fixed and Dashboard for XWiki 13.1>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=14692]].
38
39 {{releasenotechanges/}}
40
41 === Upgrades ===
42
43 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]]):
44
45 * [[Syntax Highlighting 4.6>>https://jira.xwiki.org/browse/XWIKI-18359]]
46 * [[Jodconverter 4.4.2>>https://jira.xwiki.org/browse/XWIKI-18241]]
47 * [[TrueVFS 0.14.0>>https://jira.xwiki.org/browse/XWIKI-18284]]
48 * [[Solr 8.8.0>>https://jira.xwiki.org/browse/XWIKI-17377]]
49 * [[MySQL connector 8.0.23>>https://jira.xwiki.org/browse/XWIKI-18287]]
50 * [[MariaDB connector 2.7.2>>https://jira.xwiki.org/browse/XWIKI-18308]]
51 * [[Joda-Time 2.10.10>>https://jira.xwiki.org/browse/XWIKI-18316]]
52 * [[Infinispan 11.0.9.Final>>https://jira.xwiki.org/browse/XCOMMONS-2117]]
53 * [[Checker Qual 3.10.0>>https://jira.xwiki.org/browse/XCOMMONS-2132]]
54 * [[Byte Buddy 1.10.20>>https://jira.xwiki.org/browse/XCOMMONS-2131]]
55 * [[Batik 1.14>>https://jira.xwiki.org/browse/XWIKI-18285]]
56 * [[Apache XML Graphics Commons 2.6>>https://jira.xwiki.org/browse/XWIKI-18286]]
57 * [[ASM 9.1>>https://jira.xwiki.org/browse/XCOMMONS-2128]]
58 * [[CKEditor Integration 1.53.1>>https://jira.xwiki.org/browse/XWIKI-18367]]
59
60 = Translations =
61
62 The following translations have been updated:
63
64 {{language codes="de,es,fr,no"/}}
65
66 = Tested Browsers & Databases =
67
68 {{include reference="TestReports.ManualTestReportSummaryXWiki131.WebHome"/}}
69
70 {{comment}}
71 TODO: uncomment and update with proper links when the report is ready.
72
73 = Performances tests compared to <last super stable version> =
74
75 {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}}
76
77 More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]].
78 {{/comment}}
79
80 = Known issues =
81
82 * [[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]]
83
84 = Backward Compatibility and Migration Notes =
85
86 == General Notes ==
87
88 * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added:
89 ** ##xwiki.cfg##
90 ** ##xwiki.properties##
91 ** ##web.xml##
92 ** ##hibernate.cfg.xml##
93 * 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.
94
95 == Issues specific to XWiki 13.1 ==
96
97 === Breaking OfficeConverter API ===
98
99 The interface ##org.xwiki.officeimporter.converter.OfficeConverter## has been broken on purpose after [[an accepted proposal on the forum>>https://forum.xwiki.org/t/refactor-officeconverter-api-to-remove-getformatregistry/8152]]. This API was going to be broken because of the Jodconverter upgrade since the maintainer of the project moved their APIs to another package, so we took the opportunity to stop exposing in OfficeConverter classes coming from Jodconverter. Note that we introduced some new APIs to cover the usages we've seen for this API. Don't hesitate to open a feature request on Jira if some usages are not covered.
100
101 Also note that we discovered after the release that a legacy dependency was missing in the release for ##OfficeViewer## interface. See the related ticket: [[https:~~/~~/jira.xwiki.org/browse/XWIKI-20555>>https://jira.xwiki.org/browse/XWIKI-20555]]
102
103 === New Reset Password and Retrieve Username URLs ===
104
105 See above for more details. The old ##XWiki.ResetPassword## and ##XWiki.ForgotUsername## wiki pages must not be used anymore, and any custom change perform in those pages won't be taken into account (you'll need to port your changes to Java since the new feature is coded in Java). However, the pages have been kept to ensure that using the old URLs will keep working for the time being: the pages now redirect to the new URLs.
106
107 === Downgrade of Pygments from 2.5.1 to 2.4.2 ===
108
109 We've identified some issues with the [[code macro>>doc:extensions:Extension.Code Macro]] when the language property is left undefined. The language can be miss-identified, leading to a bad syntax highlighting.
110
111 For example:
112
113 {{gallery}}
114 image:xwiki-13.1.png
115 image:xwiki11.10.11.png
116 {{/gallery}}
117
118 This issue has been introduced in Pygments 2.5.1 and fixed in Pygments 2.8.0 (see the [[Pygments changes>>https://github.com/pygments/pygments/blob/master/CHANGES]] for me details). We cannot upgrade to Pygments 2.8.0 for now since it requires Python 3, which we do not support currently. If you wish to keep using Pygments 2.5.1, you can do so by replacing the Pygments jar located in ##webapps/xwiki/WEB-INF/lib/pygments-2.4.2.jar## with the the jar of [[Pygments 2.5.1>>https://nexus.xwiki.org/nexus/service/local/repositories/central/content/org/pygments/pygments/2.5.1/pygments-2.5.1.jar]].
119
120 == API Breakages ==
121
122 The following APIs were modified since XWiki 13.0:
123
124 {{backwardCompatiblityReportXml version="13.1"/}}
125
126 = Credits =
127
128 The following people have contributed code and translations to this release (sorted alphabetically):
129
130 Björn Ludwig
131 Christian Böhnke
132 ClemDee
133 Clément
134 Eduard Moraru
135 Francisco García Moreno
136 Jarle Sandmo
137 Manuel Leduc
138 Marius Dumitru Florea
139 Simon Urli
140 Thomas Mortagne
141 Vincent Massol
142 xrichard
143 XWiki

Get Connected