Wiki source code of Release Notes for $doc.getValue('product') $doc.getValue('version')
Version 3.1 by Manuel Leduc on 2025/05/16
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 | |||
| 25 | <insert description of release here> | ||
| 26 | |||
| 27 | {{velocity}} | ||
| 28 | {{jiraBlockersFor version="$version" id="xwikiorg"/}} | ||
| 29 | {{/velocity}} | ||
| 30 | |||
| 31 | = New and Noteworthy (since {{velocity}}$product{{/velocity}} <version - 1>) = | ||
| 32 | |||
 |
2.1 | 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>]]. |
| |
1.1 | 34 | |
| 35 | {{velocity}} | ||
| 36 | #if ($isBugFix) | ||
| 37 | {{jira style="list" url="https://jira.xwiki.org" fields="type, status, key, summary" source="jql"}} | ||
| 38 | resolution in (Fixed, "Solved By") 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 | |||
| 45 | === Moved Modules === | ||
| 46 | |||
| 47 | <description deprecated, retired and moved projects> | ||
| 48 | |||
| 49 | === Upgrades === | ||
| 50 | |||
| 51 | 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]]): | ||
| 52 | |||
| 53 | {{velocity}} | ||
| 54 | #if ($isFirstFinal) | ||
| 55 | #set ($affectedVersions = "${version}-rc-1, ${version}") | ||
| 56 | #else | ||
| 57 | #set ($affectedVersions = "${version}") | ||
| 58 | #end | ||
| 59 | {{jira url="https://jira.xwiki.org" source="jql" style="list"}} | ||
| 60 | project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in ($affectedVersions) AND component = "Dependency Upgrades" | ||
| 61 | {{/jira}} | ||
| 62 | {{/velocity}} | ||
| 63 | |||
| 64 | = Translations = | ||
| 65 | |||
| 66 | The following translations have been updated: | ||
| 67 | |||
| 68 | {{language codes="none, none"/}} | ||
| 69 | |||
| 70 | {{comment}} | ||
| 71 | TODO: uncomment and update with proper link when the report is ready. | ||
| 72 | |||
| 73 | = Tested Browsers & Databases = | ||
| 74 | |||
| 75 | {{include reference="TestReports.<test report page>"/}} | ||
| 76 | {{/comment}} | ||
| 77 | |||
| 78 | {{comment}} | ||
| 79 | TODO: uncomment and update with proper links when the report is ready. | ||
| 80 | |||
| 81 | = Performances tests compared to <last super stable version> = | ||
| 82 | |||
| 83 | {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}} | ||
| 84 | |||
| 85 | More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]]. | ||
| 86 | {{/comment}} | ||
| 87 | |||
| 88 | = Security Issues = | ||
| 89 | |||
| 90 | 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. | ||
| 91 | |||
| 92 | = Known issues = | ||
| 93 | |||
| 94 | * [[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]] | ||
| 95 | |||
| 96 | = Backward Compatibility and Migration Notes = | ||
| 97 | |||
| 98 | == General Notes == | ||
| 99 | |||
| 100 | * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added: | ||
| 101 | ** ##xwiki.cfg## | ||
| 102 | ** ##xwiki.properties## | ||
| 103 | ** ##web.xml## | ||
| 104 | ** ##hibernate.cfg.xml## | ||
| 105 | * 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. | ||
| 106 | |||
| 107 | == Issues specific to {{velocity}}$product $version{{/velocity}} == | ||
| 108 | |||
| |
2.1 | 109 | === Live Data Vue Components registration === |
| |
1.1 | 110 | |
| |
2.1 | 111 | With the upgrade to Vue 3, the former mechanism to load additional components is not supported. |
| 112 | If you are using code such as the one presented below, please migrate your component to Vue 3 as well, and see the [[Live Data Component store>>||anchor="HLiveDatacomponentsstore"]] section to migrate. | ||
| 113 | |||
| 114 | {{code language="javascript"}} | ||
| 115 | Vue.component('DisplayerXXX', DisplayerXXXVue2Component); | ||
| 116 | {{/code}} | ||
| 117 | |||
| |
3.1 | 118 | === New meta.vm template === |
| 119 | |||
| 120 | When the ##XWiki.XWikiPreferences^XWiki.XWikiPreferences[0].meta## field is emptied if it matched the default value when upgrading to 17.4.0RC1. | ||
| 121 | You can consult this field from the UI by going to the //Presentation// section of the administration, under the //Look & Feel// category. Then check the //HTTP Meta Info// field. | ||
| 122 | |||
| 123 | * When the ##meta## field is empty, the new ##meta.vm## template file is used. | ||
| 124 | * After upgrading, it is advised to check if the ##meta## field is empty. If that's the case and no customization has been performed, you can check the history to verify if minor, irrelevant changes can be found. If that's the case, it is possible to empty the ##meta## field by yourself. | ||
| 125 | |||
| |
1.1 | 126 | == API Breakages == |
| 127 | |||
| 128 | The following APIs were modified since {{velocity}}$product{{/velocity}} <version - 1>: | ||
| 129 | |||
| 130 | {{comment}} | ||
| 131 | Remove! | ||
| 132 | {{velocity}} | ||
| 133 | {{backwardCompatibilityReport134 version="$version"/}} | ||
| 134 | {{/velocity}} | ||
| 135 | {{/comment}} | ||
| 136 | |||
| 137 | = Credits = | ||
| 138 | |||
| 139 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
| 140 | |||
| 141 | <code and translation contributors> |
