Last modified by Ilie Andriuta on 2020/06/01
From version 1.1
edited by Simon Urli
on 2020/01/27
Change comment: New Release note
To version 2.1
edited by Simon Urli
on 2020/01/27
Change comment: Prepare release

Summary

Details

Page properties
Content
... ... @@ -4,23 +4,50 @@
4 4  
5 5  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.
6 6  
7 -<insert description of release here>
7 +To start this new year, we have updated a lot of our dependencies, to give some freshness to the whole platform. For administrators, it is now possible to define name strategies for new pages. For developers, the new big change is the upgrade of Velocity to the new 2.2 version, which support new syntax expressions. In addition, more than 40 bugs has been fixed since the release of XWiki 11.10.
8 8  
9 -= New and Noteworthy (since XWiki <version - 1>) =
9 +{{warning}}
10 + TBD: Velocity regression message.
11 +{{/warning}}
10 10  
11 -[[Full list of issues fixed and Dashboard for <full version here even for RC, e.g. 10.5>>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]].
13 += New and Noteworthy (since XWiki 11.10.2) =
12 12  
15 +[[Full list of issues fixed and Dashboard for XWiki 12.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=14472]].
16 +
13 13  {{releasenotechanges/}}
14 14  
15 -=== Moved Modules ===
16 -
17 -<description deprecated, retired and moved projects>
18 -
19 19  === Upgrades ===
20 20  
21 21  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]]):
22 22  
23 -* <list libraries that have been upgraded>
23 +* [[CSS4J 2.0.0>>https://jira.xwiki.org/browse/XWIKI-16905]]
24 +* [[Tour Application 1.3.2>>https://jira.xwiki.org/browse/XWIKI-16981]]
25 +* [[CKEditor Integration 1.39>>https://jira.xwiki.org/browse/XWIKI-16951]]
26 +* [[Apache PDFBox 2.0.18>>https://jira.xwiki.org/browse/XWIKI-16941]]
27 +* [[c3p0 v0.9.5.5>>https://jira.xwiki.org/browse/XWIKI-16917]]
28 +* [[PostgresSQL connector 42.2.9>>https://jira.xwiki.org/browse/XWIKI-16914]]
29 +* [[Tika 1.23>>https://jira.xwiki.org/browse/XWIKI-16913]]
30 +* [[Hibernate 5.4.10>>https://jira.xwiki.org/browse/XWIKI-16912]]
31 +* [[RequireJS 2.3.6>>https://jira.xwiki.org/browse/XWIKI-16907]]
32 +* [[JQuery 2.2.4>>https://jira.xwiki.org/browse/XWIKI-16906]]
33 +* [[Pygments 2.5.1>>https://jira.xwiki.org/browse/XWIKI-16888]]
34 +* [[Embedded Maven 3.6.3>>https://jira.xwiki.org/browse/XWIKI-16884]]
35 +* [[Protobuf Java 3.11.1>>https://jira.xwiki.org/browse/XWIKI-16883]]
36 +* [[Servlet 3.1>>https://jira.xwiki.org/browse/XWIKI-16829]]
37 +* [[Jackson 2.10.2>>https://jira.xwiki.org/browse/XCOMMONS-1832]]
38 +* [[Commons-codec 1.14>>https://jira.xwiki.org/browse/XCOMMONS-1831]]
39 +* [[Guava 28.2-jre>>https://jira.xwiki.org/browse/XCOMMONS-1829]]
40 +* [[SLF4J 1.7.30>>https://jira.xwiki.org/browse/XCOMMONS-1822]]
41 +* [[Log4j API 2.13.0>>https://jira.xwiki.org/browse/XCOMMONS-1821]]
42 +* [[Saxon 9.9.1-6>>https://jira.xwiki.org/browse/XCOMMONS-1818]]
43 +* [[Woodstox 6.0.3>>https://jira.xwiki.org/browse/XCOMMONS-1817]]
44 +* [[Infinispan 9.4.17.Final>>https://jira.xwiki.org/browse/XCOMMONS-1816]]
45 +* [[Error Prone annotations 2.3.4>>https://jira.xwiki.org/browse/XCOMMONS-1812]]
46 +* [[Checker Qual 3.1.0>>https://jira.xwiki.org/browse/XCOMMONS-1811]]
47 +* [[AspectJ 1.9.5>>https://jira.xwiki.org/browse/XCOMMONS-1806]]
48 +* [[Jakarta Annotations 1.3.5>>https://jira.xwiki.org/browse/XCOMMONS-1805]]
49 +* [[Velocity Tools 3.0>>https://jira.xwiki.org/browse/XCOMMONS-1529]]
50 +* [[Velocity 2.2>>https://jira.xwiki.org/browse/XCOMMONS-1296]]
24 24  
25 25  = Translations =
26 26  
... ... @@ -61,17 +61,39 @@
61 61  ** ##hibernate.cfg.xml##
62 62  * 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.
63 63  
64 -== Issues specific to XWiki <version> ==
91 +== Issues specific to XWiki 12.0 ==
65 65  
66 -<issues specific to the project>
93 +=== Velocity 2.2 upgrade ===
67 67  
95 +While Velocity upgrade bring a lot of nice new improvements it also comes with unavoidable behavior changes that might be a breackage for your scripts or break some extensions:
96 +
97 +* The [[Velocity Java API changed quite a lot>>https://velocity.apache.org/engine/2.2/upgrading.html]], if you use advanced features directly in Java there is a big chance that you need to update your code.
98 +* Most names of Velocity configuration properties have changed ; old names are still functional but will emit a deprecation warning in the log. See the [[Configuration Changes in Velocity 2.1>>https://velocity.apache.org/engine/2.2/configuration-property-changes-in-2.1.html]] page.
99 +* We tried to reduce as much as possible the breaking changes in the language using some retro compatibility flags provided by Velocity and some hacks on XWiki side but there is still things for which you might want to be carefull:
100 +** Deprecations: A lot of APIs are now deprecated, they should work fine but will produce a warning in the log (unless you disabled that using the new property ##logging.deprecated.enabled## in ##xwiki.properties##)
101 +*** ##$listtool## was already deprecatedd since Velocity 1.6 which added support for allows all List methods to be called on arrays
102 +*** ##$sorttool## replaced by ##$collectiontool##
103 +*** ##$velocityCount## and ##$velocityHasNext## where already deprecated in Velocity 1.7 without producing any deprecation warning, they now do
104 +
105 +{{info}}
106 + TO BE ADAPTED
107 +** Breackages:
108 +*** No more Velocity macro semi-local context: in Velocity 1.7 variable set inside a macro were set both in the global context and in a special macro local context. In Velocity 2.x this local context does not exist anymore. In pratice in means that if, in your macro, you ###set## a variable and execute another Velocity template which set the same variable your macro will be affected while it used to be "protected" by the previous explicit ###set##. It's now (since Velocity 1.7 actually) recommended to use the $macro map to manipulate local variable (as in {{code}}#set($macro.myLocalVar = "value"){{/code}}).
109 +** Known bugs:
110 +*** [[Macro parameter names problem with expression passed to the macro>>https://issues.apache.org/jira/browse/VELOCITY-904?focusedCommentId=17019513&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17019513]]. Should be fixed in 12.0 final.
111 +{{/info}}
112 +
113 +=== Servlet 3.1 upgrade ===
114 +
115 +XWiki now requires an application supporting Servlet 3.1 at least. This means for example that XWiki won't work in Tomcat 7 anymore.
116 +
68 68  == API Breakages ==
69 69  
70 -The following APIs were modified since <project> <version - 1>:
119 +The following APIs were modified since XWiki 11.10.2:
71 71  
72 72  {{comment}}
73 73  Remove!
74 -{{backwardCompatiblityReport version="<version>"/}}
123 +{{backwardCompatiblityReport version="12.0"/}}
75 75  {{/comment}}
76 76  
77 77  = Credits =

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected