[
https://jira.codehaus.org/browse/MPLUGIN-263?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=344174#comment-344174
]
Brian de Alwis commented on MPLUGIN-263:
----------------------------------------
This is user-error: I misunderstood the help text generated:
$ mvn help:describe -Ddetail=true -Dplugin=org.eclipse.ebr:ebr-maven-plugin
-Dgoal=create-recipe
[?]
artifactVersion (Default: RELEASE)
User property: version
(no description available)
I assumed since "artifactVersion" was the first thing listed, with a default,
that it was the property name ? after all, I'm trying to understand the
available properties that I need to configure. To my mind, "artifactVersion"
is an internal detail to the mojo.
> Generated plugin-help.xml uses field name rather than parameter property name
> -----------------------------------------------------------------------------
>
> Key: MPLUGIN-263
> URL: https://jira.codehaus.org/browse/MPLUGIN-263
> Project: Maven Plugin Tools
> Issue Type: Bug
> Components: Plugin Plugin
> Affects Versions: 3.2
> Reporter: Brian de Alwis
> Priority: Minor
> Attachments: plugin-help.xml
>
>
> The org.eclipse.ebr:ebr-maven-plugin [1] uses Java5 annotations to indicate
> plugin parameters. It has one parameter [2] where the parameter property
> name does not match the field name.
> @Parameter(property = "version", defaultValue = "RELEASE")
> private String artifactVersion;
> The resulting plugin-help.xml document (attached) references the field name,
> and not the property name.
> <parameter>
> <name>artifactVersion</name>
> <type>java.lang.String</type>
> <required>false</required>
> <editable>true</editable>
> <description></description>
> </parameter>
> This should use the parameter property name, "version".
> [1] Download a snapshot at
> <https://git.eclipse.org/c/ebr/org.eclipse.ebr.recipes.git/snapshot/org.eclipse.ebr.recipes-master.zip>
> and look in releng/ebr-maven-plugin
> [2] Code for this mojo:
> <https://git.eclipse.org/c/ebr/org.eclipse.ebr.recipes.git/tree/releng/ebr-maven-plugin/src/main/java/org/eclipse/ebr/maven/CreateRecipeMojo.java>
--
This message was sent by Atlassian JIRA
(v6.1.6#6162)
