Release Notes

Last modified by Vincent Massol on 2026/09/09 13:53

Explanation

The Release Notes Application is mostly wiki pages: a handful of XClasses, five wiki macros and one page per rendering layout. Release Notes Application 2.7+ Under them sits a Component module holding the change search and the creation of release notes and changes, reachable from Java, from a script and over HTTP.

That makes each of its parts replaceable from the wiki itself. Release Note Structure describes the pages and xobjects everything else works on. The getChanges and displayChanges macros query and render changes, so you can build views of your own, while releasenotechanges, releasenotecontributors and html5video are what a release note itself is made of. Create a Release Note Template changes what a new release note starts from, and Create a Change Displayer adds a layout of your own.

Creating release notes and changes is scriptable as well as clickable. The REST API does it from outside the wiki, for a release script or an agent; the Script Service does it from a wiki page; and the Java API does it from an extension of your own. All three go through the same components, so a note or a change created through one is indistinguishable from one created through another, or by hand.

FAQ

Where is the source code?

In the xwiki-contrib/application-releasenotes repository on GitHub; the pages of the application are XAR resources under application-releasenotes-ui/src/main/resources.

Do I need to write Java to extend the application?

No. Templates, displayers and reports are wiki pages written in XWiki syntax and Velocity, and the creation and search API is reachable from a script.

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