Wiki source code of Release Notes for XWiki 17.10.0-rc-1
Last modified by Simon Urli on 2026/01/16 17:35
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 releases improves the DocumentTree and Children macro usage from WYSIWYG by adding new pickers for some parameters, and provides a refresh look for the Search results page. A new experimental features is provided for admins (and developers) with the ability to save page attachments in Amazon S3 (or compatible stores). | ||
| 26 | |||
| 27 | {{velocity}} | ||
| 28 | {{jiraBlockersFor version="$version" id="xwikiorg"/}} | ||
| 29 | {{/velocity}} | ||
| 30 | |||
| 31 | = New and Noteworthy (since {{velocity}}$product{{/velocity}} 17.9.0) = | ||
| 32 | |||
| 33 | [[Full list of issues fixed and Dashboard for 17.10.0>>https://jira.xwiki.org/secure/Dashboard.jspa?selectPageId=16507]]. | ||
| 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 | = Translations = | ||
| 61 | |||
| 62 | The following translations have been updated: | ||
| 63 | |||
| 64 | {{language codes="ca,da,de,es,fr,hr,lv,ro,ru,uk"/}} | ||
| 65 | |||
| 66 | = Tested Browsers & Databases = | ||
| 67 | |||
| 68 | == Automated testing == | ||
| 69 | |||
| 70 | XWiki executes a lot of [[automated tests during its build>>dev:Community.Testing.WebHome||anchor="HTestingStrategy"]], testing all [[supported configurations>>dev:Community.SupportStrategy.WebHome]]. In addition, some manual QA is also executed to try to discover additional problems (see below): | ||
| 71 | |||
| 72 | {{include reference="TestReports.ManualTestReportSummaryXWiki17100.WebHome"/}} | ||
| 73 | |||
| 74 | {{comment}} | ||
| 75 | TODO: uncomment and update with proper links when the report is ready. | ||
| 76 | |||
| 77 | = Performances tests compared to <last super stable version> = | ||
| 78 | |||
| 79 | {{display reference="test:Performances.Jetty HSQLDB single wiki xxx to yyy" section="HSummary"/}} | ||
| 80 | |||
| 81 | More details on [[performance comparison on single wiki between x.x and y.y>>test:Performances.Jetty HSQLDB single wiki xxx to yyy]]. | ||
| 82 | {{/comment}} | ||
| 83 | |||
| 84 | = Security Issues = | ||
| 85 | |||
| 86 | 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. | ||
| 87 | |||
| 88 | = Known issues = | ||
| 89 | |||
| 90 | * [[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]] | ||
| 91 | |||
| 92 | = Backward Compatibility and Migration Notes = | ||
| 93 | |||
| 94 | == General Notes == | ||
| 95 | |||
| 96 | * When upgrading make sure you compare and merge the following XWiki configuration files since some parameters may have been modified, removed or added: | ||
| 97 | ** ##xwiki.cfg## | ||
| 98 | ** ##xwiki.properties## | ||
| 99 | ** ##web.xml## | ||
| 100 | ** ##hibernate.cfg.xml## | ||
| 101 | * 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. | ||
| 102 | |||
| 103 | == Issues specific to {{velocity}}$product $version{{/velocity}} == | ||
| 104 | |||
| 105 | === Apache HttpClient 3 is not included in XWiki Standard anymore === | ||
| 106 | |||
| 107 | Apache HttpClient 3 having an important vulnerability, it was removed from XWiki Standard 17.10.0-rc-1 and 17.4.8. This means that an extension that relies on the fact that it's there without declaring it as a dependency won't work anymore. Of course it's true also for any custom script that expects it to exist. | ||
| 108 | |||
| 109 | While it's technically easy to reinstall extension ##commons-httpclient:commons-httpclient## (last version is 3.1), it's highly recommended to instead rewrite whatever code which needed it to use another library (like HttpClient 5, for example). | ||
| 110 | |||
| 111 | Note that to fully remove that dependency, we also had to remove the ##com.xpn.xwiki.XWiki#getHttpClient## API. | ||
| 112 | |||
| 113 | === Possible change in the wiki on which a REST request is authenticated | ||
| 114 | |||
| 115 | Starting with 17.10.0-rc-1, REST requests are authenticated on the wiki indicated in the path when using the format ##/rest/wikis/<wikiid>/##. It used to be authenticated based on the wiki matching the domain (so always the main wiki in the case of path-based multiwiki). | ||
| 116 | |||
| 117 | === The ##webjar-node## handler is now using ##pnpm## === | ||
| 118 | |||
| 119 | The [[##webjar-node## Handler>>doc:dev:Community.WebJar Node Maven Handler.WebHome]], introduced in [[17.5.0>>doc:ReleaseNotes.Data.XWiki.17\.5\.0.WebHome||anchor="HImprovedsupportforwebjarbuiltusingnode"]] is now using ##pnpm## instead of ##npm##. All the packages using this handler in ##xwiki-platform## have been migrated. | ||
| 120 | |||
| 121 | If you are using this handler in a contrib extension, the main change is to remove the ##package-lock.json## located in ##src/main/node## and to produce a ##pnpm-lock.yml## instead by running {{code language="bash"}}pnpm install{{/code}} in the directory. | ||
| 122 | |||
| 123 | === Removal of withTip and useTitleAsTip CSS class behaviour === | ||
| 124 | |||
| 125 | Two CSS classes were defined in the past for working around Internet Explorer limitations regarding values in form inputs: ##withTip## and ##useTitleAsTip##. However it was advised to not rely on those CSS class anymore and to rely on placeholder input attribute only. We now removed the support of those CSS classes in XWiki. | ||
| 126 | |||
| 127 | == API Breakages == | ||
| 128 | |||
| 129 | The following APIs were modified since {{velocity}}$product{{/velocity}} 17.9.0: | ||
| 130 | |||
| 131 | {{velocity}} | ||
| 132 | {{backwardCompatibilityReport134 version="$version"/}} | ||
| 133 | {{/velocity}} | ||
| 134 | |||
| 135 | = Credits = | ||
| 136 | |||
| 137 | The following people have contributed code and translations to this release (sorted alphabetically): | ||
| 138 | |||
| 139 | * Alex Cotiugă | ||
| 140 | * Cédric LAMBLIN | ||
| 141 | * Farcasut | ||
| 142 | * Josue-T | ||
| 143 | * LucasC | ||
| 144 | * Manuel Leduc | ||
| 145 | * Marius Dumitru Florea | ||
| 146 | * Michael Hamann | ||
| 147 | * Simon Urli | ||
| 148 | * Simpel | ||
| 149 | * Thomas Mortagne | ||
| 150 | * Vincent Massol | ||
| 151 | * xrichard |