[SCM-390] scm:branch gives misleading error when branch name parameter is missing

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.0
• Fix Version/s: 1.1
• Component/s: maven-plugin
• Flags: Patch
• Assignee: Siveton Vincent
• Reporter: Mark Hobson
• Created: 23/Jul/08 05:00
• Updated: 08/Feb/20 15:40
• Resolved: 18/Aug/08 07:35

Description

Running scm:branch without a branch name results in the misleading error:

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] Cannot run branch command :

Embedded error: Exception while executing SCM command.
Missing parameter: 'branchName'.
[INFO] ------------------------------------------------------------------------

The actual branch name parameter is called 'branch', but the error message complains about a missing 'branchName' parameter. This is due to the discrepancy between scm command and mojo parameter names.

A good fix would be to mark the branch name mojo parameter as required, since the goal is pretty useless without it. This gives a better error message:

[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] One or more required plugin parameters are invalid/missing for 'scm:branch'

[0] Inside the definition for plugin 'maven-scm-plugin' specify the following:

<configuration>
  ...
  <branch>VALUE</branch>
</configuration>

-OR-

on the command line, specify: '-Dbranch=VALUE'

[INFO] ------------------------------------------------------------------------