Release Notes

Last modified by Vincent Massol on 2026/08/28 21:30

Explanation

The Release Notes Application is a contributed extension that an administrator installs from the Extension Manager, and it needs XWiki 14.10 or later.

It stores everything as ordinary wiki pages below the space it is installed in, so the usual page rights decide who may read a release note and who may add changes to it. Nothing else has to be administered beyond the application's own configuration page, which holds the product name and the template that new release notes start from: Configure the Release Notes Application.

FAQ

How can I try the application with sample data?

Install the org.xwiki.contrib.releasenotes:application-releasenotes-demo extension through the Extension Manager's advanced search, which adds sample release notes for XWiki 8.3.

Can the application live somewhere other than the ReleaseNotes space?

Yes. The application resolves its own top-level space at runtime, so a copy or a rename keeps working; see Release Note Structure.

Release changes created with version 1.x are displayed empty. What should I do?

Open the "Migration from 1.x" page in the application's code space and start the migration, which converts the old change objects to the current format. The application home page links to it while any such change remains.

More

To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.

Related

Get Connected