Wiki source code of Release Notes for $doc.getValue('product') $doc.getValue('version')
Version 2.1 by Vincent Massol on 2024/06/12
Show last authors
author | version | line-number | content |
---|---|---|---|
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}} <version - 1>) = | ||
41 | |||
42 | [[Full list of issues fixed and Dashboard for <final version here even for RC, e.g. 10.5>>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=<fill id here>]]. | ||
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 | * [[Guava 33.2.0-jre>>https://jira.xwiki.org/browse/XCOMMONS-3058]] | ||
55 | * [[Byte Buddy 1.14.15>>https://jira.xwiki.org/browse/XCOMMONS-3060]] | ||
56 | * [[Commons Exec 1.4.0>>https://jira.xwiki.org/browse/XCOMMONS-3057]] | ||
57 | * [[Guava failureaccess 1.0.2>>https://jira.xwiki.org/browse/XCOMMONS-3059]] | ||
58 | * [[Checker Qual 3.42.0>>https://jira.xwiki.org/browse/XCOMMONS-3055]] | ||
59 | * [[Error Prone Annotations 2.26.1>>https://jira.xwiki.org/browse/XCOMMONS-3056]] | ||
60 | * [[Docker Java 3.3.6>>https://jira.xwiki.org/browse/XWIKI-22256]] | ||
61 | |||
62 | = Translations = | ||
63 | |||
64 | The following translations have been updated: | ||
65 | |||
66 | {{language codes="none, none"/}} | ||
67 | |||
68 | {{comment}} | ||
69 | TODO: uncomment and update with proper link when the report is ready. | ||
70 | |||
71 | = Tested Browsers & Databases = | ||
72 | |||
73 | {{include reference="TestReports.<test report page>"/}} | ||
74 | {{/comment}} | ||
75 | |||
76 | {{comment}} | ||
77 | TODO: uncomment and update with proper links when the report is ready. | ||
78 | |||
79 | = Performances tests compared to <last super stable version> = | ||
80 | |||
81 | {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}} | ||
82 | |||
83 | More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]]. | ||
84 | {{/comment}} | ||
85 | |||
86 | = Security Issues = | ||
87 | |||
88 | 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. | ||
89 | |||
90 | = Known issues = | ||
91 | |||
92 | * [[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]] | ||
93 | |||
94 | = Backward Compatibility and Migration Notes = | ||
95 | |||
96 | == General Notes == | ||
97 | |||
98 | * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added: | ||
99 | ** ##xwiki.cfg## | ||
100 | ** ##xwiki.properties## | ||
101 | ** ##web.xml## | ||
102 | ** ##hibernate.cfg.xml## | ||
103 | * 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. | ||
104 | |||
105 | == Issues specific to {{velocity}}$product $version{{/velocity}} == | ||
106 | |||
107 | <issues specific to the project> | ||
108 | |||
109 | == API Breakages == | ||
110 | |||
111 | The following APIs were modified since {{velocity}}$product{{/velocity}} <version - 1>: | ||
112 | |||
113 | {{comment}} | ||
114 | Remove! | ||
115 | {{velocity}} | ||
116 | {{backwardCompatibilityReport134 version="$version"/}} | ||
117 | {{/velocity}} | ||
118 | {{/comment}} | ||
119 | |||
120 | = Credits = | ||
121 | |||
122 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
123 | |||
124 | <code and translation contributors> |