Maven 1.x Announcement Plugin

A way to override the team name in "The ${pom.groupId} team"

Details

  • Type: Wish Wish
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: 1.4
  • Fix Version/s: 1.4
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    1

Description

It would be cool if there was a way to override the team name in the announcement.jsl.

Something like

maven.announcement.teamname = ${pom.groupId}

and use this instead of ${pom.groupId} in the jsl.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Shinobu Kawai added a comment -

The patch to grant my wish.

Show
Shinobu Kawai added a comment - The patch to grant my wish.
Hide
Permalink
Felipe Leme added a comment -

Hi Shinobu,

Can't you just use a customized announcements.jsl instead?

My only concern with this type of improvement is that we will be add another property for just a specific part of the announcement. Why not on other parts as well?

Anyway, let's wait for Vincent's opinion.

– Felipe

PS: in case we decide to fix it, could you please provide a full patch, including modifications on xdocs/plugin.properties (explaining the new property), xdocs/changes.xml (with this new fix), project.xml (adding yourself as contributor), plugin.properties (setting the property and it's default value) and the changes itself (in this case, announcement.jsl)?

Show
Felipe Leme added a comment - Hi Shinobu, Can't you just use a customized announcements.jsl instead? My only concern with this type of improvement is that we will be add another property for just a specific part of the announcement. Why not on other parts as well? Anyway, let's wait for Vincent's opinion. – Felipe PS: in case we decide to fix it, could you please provide a full patch, including modifications on xdocs/plugin.properties (explaining the new property), xdocs/changes.xml (with this new fix), project.xml (adding yourself as contributor), plugin.properties (setting the property and it's default value) and the changes itself (in this case, announcement.jsl)?
Hide
Permalink
Shinobu Kawai added a comment -

Hi Felipe,

Oops, I overlooked this guy:
maven.announcement.stylesheet.path

I guess I can live with that. I don't like copy and pasting, though.

  1. And if you do decide to add the new property, sure I can make the full patch.

Best regards,
– Shinobu Kawai

Show
Shinobu Kawai added a comment - Hi Felipe, Oops, I overlooked this guy: maven.announcement.stylesheet.path I guess I can live with that. I don't like copy and pasting, though.
  1. And if you do decide to add the new property, sure I can make the full patch.
Best regards, – Shinobu Kawai
Hide
Permalink
Felipe Leme added a comment -

I agree with you, a property is better than a full copy-and-paste. I'm just worried we would be 'bloating' the plugin with more properties (I already added a lot in the past issue

Anyway, let's wait for a third opinion (i.e., Vincente .

Show
Felipe Leme added a comment - I agree with you, a property is better than a full copy-and-paste. I'm just worried we would be 'bloating' the plugin with more properties (I already added a lot in the past issue Anyway, let's wait for a third opinion (i.e., Vincente .
Hide
Permalink
Vincent Massol added a comment -

Hi,

The feature of choosing the group name is already implemented in the plugin. It is using the POM groupId name. I'd like to know why this is not enough and what is the rationale behind choosing another property for this.

Note: I'm not against it, I'd just like to better understand in other to offer the best possible design for this

Thanks

Show
Vincent Massol added a comment - Hi, The feature of choosing the group name is already implemented in the plugin. It is using the POM groupId name. I'd like to know why this is not enough and what is the rationale behind choosing another property for this. Note: I'm not against it, I'd just like to better understand in other to offer the best possible design for this Thanks
Hide
Permalink
Shinobu Kawai added a comment -

Hi Vincent,

This all came from my plugin devolpment, the Maven DocCheck Plugin.
http://maven-doccheck.sourceforge.net/

This plugin produces a report using Sun's Doc Check Doclet. The doclet itself is made in Sun. I thought the phrase "The doccheck team" could be taken to refer to the Sun team, whereas the plugin itself is by a different team (me!). In order to avoid confusion, I wanted to emphasize that the release was made by "The Maven-DocCheck team". Hence, the new property proposal.
http://maven-doccheck.sourceforge.net/announcements/announcement-1.4-0.1.txt

  1. In retrospect, I guess I could have used "maven-doccheck-plugin" as my group id in the first place.

Best regards,
– Shinobu Kawai

Show
Shinobu Kawai added a comment - Hi Vincent, This all came from my plugin devolpment, the Maven DocCheck Plugin. http://maven-doccheck.sourceforge.net/ This plugin produces a report using Sun's Doc Check Doclet. The doclet itself is made in Sun. I thought the phrase "The doccheck team" could be taken to refer to the Sun team, whereas the plugin itself is by a different team (me!). In order to avoid confusion, I wanted to emphasize that the release was made by "The Maven-DocCheck team". Hence, the new property proposal. http://maven-doccheck.sourceforge.net/announcements/announcement-1.4-0.1.txt
  1. In retrospect, I guess I could have used "maven-doccheck-plugin" as my group id in the first place.
Best regards, – Shinobu Kawai
Hide
Permalink
Vincent Massol added a comment -

Thanks for the details. What would you think if we change the template to use ${pom.name} instead?

It would say: "The ${pom.name} team ..."

Or simply "We are pleased to announce..." and sign with "-The development team"?

Show
Vincent Massol added a comment - Thanks for the details. What would you think if we change the template to use ${pom.name} instead? It would say: "The ${pom.name} team ..." Or simply "We are pleased to announce..." and sign with "-The development team"?
Hide
Permalink
Shinobu Kawai added a comment -

Hey, that'll be perfect!

Show
Shinobu Kawai added a comment - Hey, that'll be perfect!
Hide
Permalink
Vincent Massol added a comment -

Which one do you prefer:

1/ the use of ${pom.name}
or
2/ the use of "We are pleased..."
?

Show
Vincent Massol added a comment - Which one do you prefer: 1/ the use of ${pom.name} or 2/ the use of "We are pleased..." ?
Hide
Permalink
Shinobu Kawai added a comment -

I like
1/ the use of ${pom.name}
better, but wouldn't complain if it were the other.

Show
Shinobu Kawai added a comment - I like 1/ the use of ${pom.name} better, but wouldn't complain if it were the other.
Hide
Permalink
Vincent Massol added a comment -

Done.

Show
Vincent Massol added a comment - Done.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.