Maven 2.x Changes Plugin

Add an element for free text notes to a Release

Details

  • Type: Improvement Improvement
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 2.3
  • Fix Version/s: None
  • Component/s: changes.xml, modello
  • Labels:
    None
  • Number of attachments :
    0

Description

Currently there is no ability to add some free text release notes for a release (except than creating a dummy action).

It would be nice if there would be a possibility to add a further tag beyond a release ('notes') which would be rendered in top of the list (perhaps using WIKI-Syntax?)

Or provide a possibility to add a link to an apt-page.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Dennis Lundberg added a comment -

You can use the description attribute of the <release> element.
See http://maven.apache.org/plugins/maven-changes-plugin/changes.html#class_release

Show
Dennis Lundberg added a comment - You can use the description attribute of the <release> element. See http://maven.apache.org/plugins/maven-changes-plugin/changes.html#class_release
Hide
Permalink
Michael Wenig added a comment -

I know about the description attribute. But this is for a "short description" and not suitable for longer text. We do use it currently as a workaround to link to a wiki page we would prefer to hold the notes inside the project beside the changes (otherwise 'noone ever updates it'). A tag would be better here.

Show
Michael Wenig added a comment - I know about the description attribute. But this is for a "short description" and not suitable for longer text. We do use it currently as a workaround to link to a wiki page we would prefer to hold the notes inside the project beside the changes (otherwise 'noone ever updates it'). A tag would be better here.
Hide
Permalink
Michael Wenig added a comment -

I know about the description attribute. But this is for a "short description" and not suitable for longer text. We do use it currently as a workaround to link to a wiki page we would prefer to hold the notes inside the project beside the changes (otherwise 'noone ever updates it'). A tag would be better here.

Show
Michael Wenig added a comment - I know about the description attribute. But this is for a "short description" and not suitable for longer text. We do use it currently as a workaround to link to a wiki page we would prefer to hold the notes inside the project beside the changes (otherwise 'noone ever updates it'). A tag would be better here.
Hide
Permalink
Dennis Lundberg added a comment -

What is the problem with creating a "dummy" action, and what is it about it that makes you call it "dummy"?

Show
Dennis Lundberg added a comment - What is the problem with creating a "dummy" action, and what is it about it that makes you call it "dummy"?
Hide
Permalink
Michael Wenig added a comment -

A Release-Notes-Text should be rendered above the table with the changes. Using a 'dummy action' (I call it dummy as it is no action directly related to an issue or code-change but a ontainer for 'anything that has to do with this release') the text would be rendered as a table row and is therefore not popular enough. Additionally this would semantically be incorrect as an action is defined as 'A single action done on the project, during this release' and is not suitable for something the deployer has to keep in mind.

I would like to have a report like

  • Release 123.*

Notes:
Be careful to run the migrationJob xyz after installing it!
An Update of the admins profile data is needed for this release. So ....

Changes:

TEST-1 invent a new look and feel
TEST-2 Download of xyz is not possible

...

I hope it is clear now.

Show
Michael Wenig added a comment - A Release-Notes-Text should be rendered above the table with the changes. Using a 'dummy action' (I call it dummy as it is no action directly related to an issue or code-change but a ontainer for 'anything that has to do with this release') the text would be rendered as a table row and is therefore not popular enough. Additionally this would semantically be incorrect as an action is defined as 'A single action done on the project, during this release' and is not suitable for something the deployer has to keep in mind. I would like to have a report like Release 123.* Notes: Be careful to run the migrationJob xyz after installing it! An Update of the admins profile data is needed for this release. So .... Changes: TEST-1 invent a new look and feel TEST-2 Download of xyz is not possible ... I hope it is clear now.

People

  • Assignee:
    Unassigned
    Reporter:
    Michael Wenig
Vote (2)
Watch (2)

Dates

  • Created:
    Updated: