Wiki source code of Release Notes for $doc.getValue('product') $doc.getValue('version')
Version 4.1 by Thomas Mortagne on 2024/03/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 | * [[dompurify 3.0.9>>https://jira.xwiki.org/browse/XWIKI-21905]] | ||
| 55 | * [[Jetty 10.0.20>>https://jira.xwiki.org/browse/XWIKI-21948]] | ||
| 56 | |||
| 57 | = Translations = | ||
| 58 | |||
| 59 | The following translations have been updated: | ||
| 60 | |||
| 61 | {{language codes="none, none"/}} | ||
| 62 | |||
| 63 | {{comment}} | ||
| 64 | TODO: uncomment and update with proper link when the report is ready. | ||
| 65 | |||
| 66 | = Tested Browsers & Databases = | ||
| 67 | |||
| 68 | {{include reference="TestReports.<test report page>"/}} | ||
| 69 | {{/comment}} | ||
| 70 | |||
| 71 | {{comment}} | ||
| 72 | TODO: uncomment and update with proper links when the report is ready. | ||
| 73 | |||
| 74 | = Performances tests compared to <last super stable version> = | ||
| 75 | |||
| 76 | {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}} | ||
| 77 | |||
| 78 | More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]]. | ||
| 79 | {{/comment}} | ||
| 80 | |||
| 81 | = Security Issues = | ||
| 82 | |||
| 83 | 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. | ||
| 84 | |||
| 85 | = Known issues = | ||
| 86 | |||
| 87 | * [[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]] | ||
| 88 | |||
| 89 | = Backward Compatibility and Migration Notes = | ||
| 90 | |||
| 91 | == General Notes == | ||
| 92 | |||
| 93 | * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added: | ||
| 94 | ** ##xwiki.cfg## | ||
| 95 | ** ##xwiki.properties## | ||
| 96 | ** ##web.xml## | ||
| 97 | ** ##hibernate.cfg.xml## | ||
| 98 | * 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. | ||
| 99 | |||
| 100 | == Issues specific to {{velocity}}$product $version{{/velocity}} == | ||
| 101 | |||
| 102 | === Move to Jersey | ||
| 103 | |||
| 104 | The XWiki REST API used to rely on Restlet and now moved to Jersey 2. | ||
| 105 | |||
| 106 | We took great care to keep the same behavior as much as possible but there are some differences: | ||
| 107 | * obviously, if you were using directly any Reslet class (which was something recommended not to do), your code won't work anymore | ||
| 108 | * there was some bugs in the Restlet implementation of the URIBuilder, the good and bad news is that they are fixed in Jersey: one that was hit already is that Restlet was not escaping `/` contained in parameters passed to the URIBuilder. So if your code was relying on this behavior you are going to have problems and you should custom the parameter in several instead (which should work fine with Restlet too if you need it to keep working with XWiki < 16.2.0) | ||
| 109 | * Restlet added a lot of custom behavior on top of JAX-RS and HTTP specifications, especially regarding the special meaning of some URL parameters. We only kept what was documented in https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiRESTfulAPI (so the "media" parameter which allows overwriting the HTTP request Accept value, and the "method" parameter which allows to overwrite the HTTP request method, both of which are only here for retro-compatibility reasons and we highly recommend to use standard HTTP instead) | ||
| 110 | |||
| 111 | === Upgrade to Antlr 4.10+ | ||
| 112 | |||
| 113 | Antlr introduce a breaking change in version 4.10 which make impossible to run something which was built with a version of Antlr 4 lower than 4.10. | ||
| 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> |
