Wiki source code of Release Notes for $doc.getValue('product') $doc.getValue('version')
Version 3.1 by Thomas Mortagne on 2023/02/14
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 | * [[CSS4J & CSS4J-DOM4J 3.9.1>>https://jira.xwiki.org/browse/XWIKI-20641]] | ||
| 55 | * [[XML-DTD 4.1.1>>https://jira.xwiki.org/browse/XWIKI-20641]] | ||
| 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 | = Known issues = | ||
| 82 | |||
| 83 | * [[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]] | ||
| 84 | |||
| 85 | = Backward Compatibility and Migration Notes = | ||
| 86 | |||
| 87 | == General Notes == | ||
| 88 | |||
| 89 | * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added: | ||
| 90 | ** ##xwiki.cfg## | ||
| 91 | ** ##xwiki.properties## | ||
| 92 | ** ##web.xml## | ||
| 93 | ** ##hibernate.cfg.xml## | ||
| 94 | * 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. | ||
| 95 | |||
| 96 | == Issues specific to {{velocity}}$product $version{{/velocity}} == | ||
| 97 | |||
| 98 | === Reinitialization of Solr search index during migration === | ||
| 99 | |||
| 100 | A [[bug with the Solr search index>>https://jira.xwiki.org/browse/XWIKI-20619]] has been fixed as part of this release, but it needs a reindex of the documents to be properly taken into account. The migration will empty the index so that a full reindex is performed: as a consequence the search feature might take a bit of time to be entirely working after the first restart depending on the number of documents in your wiki. | ||
| 101 | |||
| 102 | == API Breakages == | ||
| 103 | |||
| 104 | The following APIs were modified since {{velocity}}$product{{/velocity}} <version - 1>: | ||
| 105 | |||
| 106 | {{comment}} | ||
| 107 | Remove! | ||
| 108 | {{velocity}} | ||
| 109 | {{backwardCompatibilityReport134 version="$version"/}} | ||
| 110 | {{/velocity}} | ||
| 111 | {{/comment}} | ||
| 112 | |||
| 113 | = Credits = | ||
| 114 | |||
| 115 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
| 116 | |||
| 117 | <code and translation contributors> |
