Uploaded image for project: 'Maven Invoker Plugin'
  1. Maven Invoker Plugin
  2. MINVOKER-208

Documentation about invoker properties related to usage of options/parameters should be improved

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: 2.0.0
    • Fix Version/s: 3.0.0
    • Labels:
      None

      Description

      The documentation http://maven.apache.org/plugins/maven-invoker-plugin/run-mojo.html#invokerPropertiesFile needed to be improved about usage of things like -DWhatEver that those things should be done with invoker.goals=.. instead of invoker.mavenOpts=...

        Issue Links

          Activity

          Hide
          Abel S.Romero Abel Salgado Romero added a comment -

          mavenOpts explanation is correct but can lead to confusion because no alternative to pass environment variables is shown.
          Adding additional explanation and example to goals should be enough.

          Current text says:
          # A comma or space separated list of goals/phases to execute, may
          # specify an empty list to execute the default goal of the IT project
          invoker.goals = clean install

          This is the proposed alternative:
          # A comma or space separated list of goals/phases to execute, may
          # specify an empty list to execute the default goal of the IT project.
          # Environment variables used by maven plugins can be added here
          invoker.goals = clean install -Dplugin.variable=value

          Show
          Abel S.Romero Abel Salgado Romero added a comment - mavenOpts explanation is correct but can lead to confusion because no alternative to pass environment variables is shown. Adding additional explanation and example to goals should be enough. Current text says: # A comma or space separated list of goals/phases to execute, may # specify an empty list to execute the default goal of the IT project invoker.goals = clean install This is the proposed alternative: # A comma or space separated list of goals/phases to execute, may # specify an empty list to execute the default goal of the IT project. # Environment variables used by maven plugins can be added here invoker.goals = clean install -Dplugin.variable=value
          Hide
          khmarbaise Karl Heinz Marbaise added a comment -

          Done in r1753102

          Show
          khmarbaise Karl Heinz Marbaise added a comment - Done in r1753102
          Hide
          khmarbaise Karl Heinz Marbaise added a comment -

          Thanks Abel Salgado Romero for your suggestions.

          Show
          khmarbaise Karl Heinz Marbaise added a comment - Thanks Abel Salgado Romero for your suggestions.
          Hide
          Abel S.Romero Abel Salgado Romero added a comment -

          Show
          Abel S.Romero Abel Salgado Romero added a comment -
          Hide
          hudson Hudson added a comment -

          SUCCESS: Integrated in maven-plugins #6992 (See https://builds.apache.org/job/maven-plugins/6992/)
          MINVOKER-208 Documentation about invoker properties related to usage of options/parameters should be improved
          o Taken the suggestions of Abel Salgado Romero. (khmarbaise: http://svn.apache.org/viewvc/?view=rev&rev=1753102)

          • maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/AbstractInvokerMojo.java
          Show
          hudson Hudson added a comment - SUCCESS: Integrated in maven-plugins #6992 (See https://builds.apache.org/job/maven-plugins/6992/ ) MINVOKER-208 Documentation about invoker properties related to usage of options/parameters should be improved o Taken the suggestions of Abel Salgado Romero. (khmarbaise: http://svn.apache.org/viewvc/?view=rev&rev=1753102 ) maven-invoker-plugin/src/main/java/org/apache/maven/plugin/invoker/AbstractInvokerMojo.java

            People

            • Assignee:
              khmarbaise Karl Heinz Marbaise
              Reporter:
              khmarbaise Karl Heinz Marbaise
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development