Wiki source code of Release Notes for $doc.getValue('product') $doc.getValue('version')
Version 3.1 by Manuel Leduc on 2025/03/10
Hide last authors
author | version | line-number | content |
---|---|---|---|
|
1.1 | 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 = $isFinal && ($versionParts.size() == 2 || $versionParts[2] == 0)) | ||
16 | #set ($isBugFix = $isFinal && $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 | |||
|
2.1 | 25 | This release is a bug fix release containing important fixes, performance improvments, and security fixes, with the [[highest severity being 8.7>>doc:dev:Community.SecurityPolicy.WebHome||anchor="HSeverity"]]. |
|
1.1 | 26 | |
27 | {{velocity}} | ||
28 | {{jiraBlockersFor version="$version" id="xwikiorg"/}} | ||
29 | {{/velocity}} | ||
30 | |||
31 | = New and Noteworthy (since {{velocity}}$product{{/velocity}} <version - 1>) = | ||
32 | |||
33 | [[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>]]. | ||
34 | |||
35 | {{velocity}} | ||
36 | #if ($isBugFix) | ||
37 | {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}} | ||
38 | resolution = Fixed AND component != "Development Issues only" and component != "Development Issues only - Test" AND project in (XCOMMONS, XRENDERING, XWIKI) AND fixVersion in ($version) | ||
39 | {{/jira}} | ||
40 | #else | ||
41 | {{releasenotechanges/}} | ||
42 | #end | ||
43 | {{/velocity}} | ||
44 | |||
|
3.1 | 45 | {{comment}} |
|
1.1 | 46 | === Moved Modules === |
47 | |||
48 | <description deprecated, retired and moved projects> | ||
|
3.1 | 49 | {{/comment}} |
|
1.1 | 50 | |
|
3.1 | 51 | {{comment}} |
|
1.1 | 52 | === Upgrades === |
53 | |||
54 | 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]]): | ||
55 | |||
56 | {{velocity}} | ||
57 | #if ($isFirstFinal) | ||
58 | #set ($affectedVersions = "${version}-rc-1, ${version}") | ||
59 | #else | ||
60 | #set ($affectedVersions = "${version}") | ||
61 | #end | ||
62 | {{jira url="https://jira.xwiki.org" source="jql" style="list"}} | ||
63 | project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in ($affectedVersions) AND component = "Dependency Upgrades" | ||
64 | {{/jira}} | ||
65 | {{/velocity}} | ||
|
3.1 | 66 | {{/comment}} |
|
1.1 | 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> |