Wiki source code of Release Notes for XWiki 17.5.0
Last modified by Simon Urli on 2025/06/30
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 | This release brings a new UI for configuring macro in the WYSIWYG editor that should provide a better user experience: parameters can be ordered, the order is stable and we clarified optional and mandatory parameters. For admins, it's now possible to overwrite properties using environment variables or Java system properties. Also we started to enforce required rights in some bundled pages, and improved the mechanism to only require admin right in skin extension. Performance has been tackled with the Solr search indexing speed. Last but not least, we defined for developers a dedicated webjar-node packaging type to help contributions using nodejs. This release also contains security fixes, with the [[highest severity being 9.3/10>>doc:dev:Community.SecurityPolicy.WebHome||anchor="HSeverity"]] | ||
| 26 | |||
| 27 | {{velocity}} | ||
| 28 | {{jiraBlockersFor version="$version" id="xwikiorg" rcSkipped="true" /}} | ||
| 29 | {{/velocity}} | ||
| 30 | |||
| 31 | = New and Noteworthy (since {{velocity}}$product{{/velocity}} 17.4.1) = | ||
| 32 | |||
| 33 | [[Full list of issues fixed and Dashboard for 17.5.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=16190]]. | ||
| 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 | #set ($affectedVersions = "${version}") | ||
| 51 | |||
| 52 | {{jira url="https://jira.xwiki.org" source="jql" style="list"}} | ||
| 53 | project in (XWIKI, XCOMMONS, XRENDERING) AND issuetype = Task AND fixVersion in ($affectedVersions) AND component = "Dependency Upgrades" | ||
| 54 | {{/jira}} | ||
| 55 | {{/velocity}} | ||
| 56 | |||
| 57 | = Translations = | ||
| 58 | |||
| 59 | The following translations have been updated: | ||
| 60 | |||
| 61 | {{language codes="de,fr,zh"/}} | ||
| 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 | === XWiki now overwrites the standard application server request URL resolution === | ||
| 103 | |||
| 104 | 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. | ||
| 105 | |||
| 106 | === REST wiki and space keyword search API uses Solr by default === | ||
| 107 | |||
| 108 | 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"]]. | ||
| 109 | |||
| 110 | === Inplace editable macro parameters are visible in the macro configuration UI === | ||
| 111 | |||
| 112 | Following the revamping of the macro configuration UI, the inplace editable macro parameters are now by default always displayed in the configuration UI, while they used to only be displayed in the configuration UI when not editable in the editor (e.g. the optional title of an optional box was displayed in the macro configuration UI before being first set only, after it was only editable through the editor itself). However, it's possible to revert to the old behaviour if needed by using the following configuration in the Administration > WYSIWYG Editor: ##config['xwiki-macro'].showInlineEditableParameters=false.## | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | == API Breakages == | ||
| 117 | |||
| 118 | The following APIs were modified since {{velocity}}$product{{/velocity}} 17.4.1: | ||
| 119 | |||
| 120 | {{velocity}} | ||
| 121 | {{backwardCompatibilityReport134 version="$version"/}} | ||
| 122 | {{/velocity}} | ||
| 123 | |||
| 124 | = Credits = | ||
| 125 | |||
| 126 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
| 127 | |||
| 128 | * anonymous | ||
| 129 | * jasongwq | ||
| 130 | * Leif Erik Andersen | ||
| 131 | * LucasC | ||
| 132 | * Manuel Leduc | ||
| 133 | * Marius Dumitru Florea | ||
| 134 | * Mend Renovate | ||
| 135 | * Michael Hamann | ||
| 136 | * Simon Urli | ||
| 137 | * Simpel | ||
| 138 | * Thomas Mortagne | ||
| 139 | * Vincent Massol | ||
| 140 | * Xiaofei Cui | ||
| 141 | * xrichard |
