Wiki source code of Release Notes for $doc.getValue('product') $doc.getValue('version')
Version 2.1 by Simon Urli on 2025/06/26
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 | |||
| 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 in (Fixed, "Solved By") AND component != "Development Issues only" AND component != "Development Issues only - Test" AND component != "Dependency Upgrades" AND project in (XCOMMONS, XRENDERING, XWIKI) AND fixVersion in ($version) | ||
| 39 | {{/jira}} | ||
| 40 | #else | ||
| 41 | {{releasenotechanges/}} | ||
| 42 | #end | ||
| 43 | {{/velocity}} | ||
| 44 | |||
| 45 | = Upgrades = | ||
| 46 | |||
| 47 | 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]]): | ||
| 48 | |||
| 49 | {{velocity}} | ||
| 50 | #if ($isFirstFinal) | ||
| 51 | #set ($affectedVersions = "${version}-rc-1, ${version}") | ||
| 52 | #else | ||
| 53 | #set ($affectedVersions = "${version}") | ||
| 54 | #end | ||
| 55 | {{jira url="https://jira.xwiki.org" source="jql" style="list"}} | ||
| 56 | project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in ($affectedVersions) AND component = "Dependency Upgrades" | ||
| 57 | {{/jira}} | ||
| 58 | {{/velocity}} | ||
| 59 | |||
| 60 | = Moved Modules = | ||
| 61 | |||
| 62 | <description deprecated, retired and moved projects> | ||
| 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 | |||
| 109 | === XWiki now overwrites the standard application server request URL resolution === | ||
| 110 | |||
| 111 | We had too many erratic/buggy behaviors with various application servers not properly following proxy headers, so we decided to not trust them anymore: XWiki now overwrite in a Servlet filter the behavior of ##ServletRequest#getScheme()##, ##ServletRequest#getServerName()##, ##ServletRequest#getServerPort()## and ##HttpServletRequest#getRequestURL()## so those should now have the same behavior to matter the application server used and its setup. | ||
| 112 | |||
| 113 | === REST wiki and space keyword search API uses Solr by default === | ||
| 114 | |||
| 115 | We've changed the backend that is used for keyword search in the REST API at the [[wiki>>doc:Documentation.UserGuide.Features.XWikiRESTfulAPI||anchor="H2Fwikis2F7BwikiName7D2Fsearch3Fq3D7Bkeywords7D5B5B26scope3D7Bname2Ccontent2Ctitle2Cobjects7D...5D26start3Dn5D5B26number3Dn5D5B26orderField3Dfield26order3D7Basc2Cdesc7D5D5Bdistinct3D7Btrue2Cfalse7D5D5B26prettyNames3D7Btrue2Cfalse7D5D"]] and [[space>>doc:Documentation.UserGuide.Features.XWikiRESTfulAPI||anchor="H2Fwikis2F7BwikiName7D2Fspaces2F7BspaceName7D5B2Fspaces2F7BnestedSpaceName7D5D2A2Fsearch3Fq3D7Bkeywords7D5B5B26scope3D7Bname2Ccontent2Ctitle2Cobjects7D...5D26number3Dn5D"]] level from the database to Solr as the database search just doesn't scale – we saw running times above a minute in installations with a million documents. While the general feature of the API is the same, finding pages from potentially partial user input, the specific behavior including the default sort order of the results is different. In case you want to restore the previous behavior, you can change the backend in the [[configuration of the REST API>>doc:Documentation.UserGuide.Features.XWikiRESTfulAPI||anchor="HConfiguration"]]. | ||
| 116 | |||
| 117 | |||
| 118 | == API Breakages == | ||
| 119 | |||
| 120 | The following APIs were modified since {{velocity}}$product{{/velocity}} <version - 1>: | ||
| 121 | |||
| 122 | {{comment}} | ||
| 123 | Remove! | ||
| 124 | {{velocity}} | ||
| 125 | {{backwardCompatibilityReport134 version="$version"/}} | ||
| 126 | {{/velocity}} | ||
| 127 | {{/comment}} | ||
| 128 | |||
| 129 | = Credits = | ||
| 130 | |||
| 131 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
| 132 | |||
| 133 | <code and translation contributors> |
