This issue has been created
There are 3 updates, 1 comment.
 
 
Release Notes Application / cid:jira-generated-image-avatar-d97819ec-adc6-4c26-81a0-90a93c94342b RN-135 Open

Define the sections of a release note in the Java API

 
View issue   ยท   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-e6061f54-042f-4dc9-af90-fcda41abee23 Vincent Massol created this issue on 30/Sep/26 18:25
 
Summary: Define the sections of a release note in the Java API
Issue Type: cid:jira-generated-image-avatar-d97819ec-adc6-4c26-81a0-90a93c94342b Improvement
Assignee: Unassigned
Components: Application
Created: 30/Sep/26 18:25
Priority: cid:jira-generated-image-static-major-a1976cd0-e210-4294-b3bc-9bef37c91415 Major
Reporter: Vincent Massol
Description:

The releasenotechanges macro defines its three sections (users, administrators, developers) in Velocity, as three near-identical blocks of getChanges calls, each with its own rule for splitting the main changes from the miscellaneous ones (the screenshots for users and administrators, the importance for developers).

Move the definition of the sections into the Java API, so that the macro keeps only the forms and the rendering:

  • a new ReleaseNoteSection class gives, for a ChangeQuery, the sections of a release note in display order, each with its audience and the queries of its main and miscellaneous changes;
  • $services.releasenotes.getSections(query) exposes it to the wiki pages;
  • ChangeQuery gets a copy constructor.

The rendered release note does not change. The getChanges and displayChanges macros keep their contract for the other pages using them.

 
 

3 updates

 
cid:jira-generated-image-avatar-e6061f54-042f-4dc9-af90-fcda41abee23 Changes by Vincent Massol on 30/Sep/26 18:25
 
Fix Version: 2.8
Version: 2.7
Assignee: Vincent Massol
 
 

1 comment

 
cid:jira-generated-image-avatar-e6061f54-042f-4dc9-af90-fcda41abee23 Vincent Massol on 30/Sep/26 18:26
 

Done in https://github.com/xwiki-contrib/application-releasenotes/pull/72. I checked that the rendering is unchanged on a wiki by swapping the ReleaseNotesChangesMacro code over REST and diffing the rendered #xwikicontent HTML. With the default template content, the HTML is identical before and after (forms included). With limit plus one exclusion, it is identical to the RN-134 fix. Nothing changes visually, so there is no screenshot.