New option to be able to disable sign for commit/tag to be able use this with jgit when you have gpgsign configured in ~/.gitconfig (#1266)

* New option to be able to disable sign for commit/tag to be able use this with jgit when you have gpgsign forced in ~/.gitconfig

---------

Signed-off-by: Olivier Lamy <[email protected]>

Author: olamy

maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameter.java

@@ -93,6 +93,13 @@ public class CommandParameter implements Serializable {
      */
     public static final CommandParameter IGNORE_WHITESPACE = new CommandParameter("ignoreWhitespace");
 
+    /**
+     * Parameter to indicate whether the commit should be signed or not.
+     * if false (default true) this will be used by the Git provider to pass the --no-signoff option to the commit command.
+     * @since 2.1.1
+     */
+    public static final CommandParameter SCM_COMMIT_SIGN = new CommandParameter("gitCommitSign");
+
     /**
      * Parameter name
      */

maven-scm-api/src/main/java/org/apache/maven/scm/CommandParameters.java

@@ -187,8 +187,7 @@ public boolean getBoolean(CommandParameter parameter) throws ScmException {
      * @throws ScmException if the parameter doesn't exist
      */
     public boolean getBoolean(CommandParameter parameter, boolean defaultValue) throws ScmException {
-        return Boolean.valueOf(getString(parameter, Boolean.toString(defaultValue)))
-                .booleanValue();
+        return Boolean.parseBoolean(getString(parameter, Boolean.toString(defaultValue)));
     }
 
     // ----------------------------------------------------------------------

maven-scm-api/src/main/java/org/apache/maven/scm/ScmTagParameters.java

@@ -35,6 +35,8 @@ public class ScmTagParameters implements Serializable {
 
     private boolean sign = false;
 
+    private boolean forceNoSign = false;
+
     private String scmRevision;
 
     public ScmTagParameters() {
@@ -87,7 +89,22 @@ public void setScmRevision(String scmRevision) {
         this.scmRevision = scmRevision;
     }
 
+    public boolean isForceNoSign() {
+        return forceNoSign;
+    }
+
+    public void setForceNoSign(boolean forceNoSign) {
+        this.forceNoSign = forceNoSign;
+    }
+
+    @Override
     public String toString() {
-        return "[" + scmRevision + "] " + message;
+        return "ScmTagParameters{" + "message='"
+                + message + '\'' + ", remoteTagging="
+                + remoteTagging + ", pinExternals="
+                + pinExternals + ", sign="
+                + sign + ", forceNoSign="
+                + forceNoSign + ", scmRevision='"
+                + scmRevision + '\'' + '}';
     }
 }

maven-scm-api/src/main/java/org/apache/maven/scm/manager/AbstractScmManager.java

@@ -25,6 +25,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
+import org.apache.maven.scm.CommandParameters;
 import org.apache.maven.scm.ScmBranch;
 import org.apache.maven.scm.ScmBranchParameters;
 import org.apache.maven.scm.ScmException;
@@ -388,6 +389,12 @@ public CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, Sc
         return this.getProviderByRepository(repository).checkIn(repository, fileSet, revision, message);
     }
 
+    @Override
+    public CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandParameters commandParameters)
+            throws ScmException {
+        return this.getProviderByRepository(repository).checkIn(repository, fileSet, commandParameters);
+    }
+
     /**
      * {@inheritDoc}
      */

maven-scm-api/src/main/java/org/apache/maven/scm/manager/ScmManager.java

@@ -22,6 +22,7 @@
 import java.util.Date;
 import java.util.List;
 
+import org.apache.maven.scm.CommandParameters;
 import org.apache.maven.scm.ScmBranch;
 import org.apache.maven.scm.ScmException;
 import org.apache.maven.scm.ScmFileSet;
@@ -280,6 +281,23 @@ ChangeLogScmResult changeLog(
      */
     CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException;
 
+    /**
+     * Save the changes you have done into the repository. This will create a new version of the file or directory in
+     * the repository.
+     * <p>
+     * When the fileSet has no entries, the {@code fileSet.getBasedir()} is recursively committed. When the fileSet
+     * has entries, the commit is non-recursive and only the elements in the fileSet are committed.
+     *
+     * @param repository the source control system
+     * @param fileSet    the files to check in (sometimes called commit)
+     * @param commandParameters parameters for the command, such as commit message and whether to sign the commit. {@link CommandParameters}
+     * @return  a {@link CheckInScmResult} that contains the file paths (relative to {@code fileSet.getBasedir()}) that
+     * have been checked in.
+     * @throws ScmException if any
+     */
+    CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandParameters commandParameters)
+            throws ScmException;
+
     /**
      * Save the changes you have done into the repository. This will create a new version of the file or directory in
      * the repository.

maven-scm-api/src/main/java/org/apache/maven/scm/provider/AbstractScmProvider.java

@@ -416,6 +416,16 @@ public CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, Sc
         return checkin(repository.getProviderRepository(), fileSet, parameters);
     }
 
+    @Override
+    public CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)
+            throws ScmException {
+        return checkIn(
+                repository,
+                fileSet,
+                parameters.getScmVersion(CommandParameter.SCM_VERSION, null),
+                parameters.getString(CommandParameter.MESSAGE));
+    }
+
     protected CheckInScmResult checkin(
             ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters) throws ScmException {
         throw new NoSuchCommandScmException("checkin");

maven-scm-api/src/main/java/org/apache/maven/scm/provider/ScmProvider.java

@@ -405,6 +405,23 @@ CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, String ta
      */
     CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, String message) throws ScmException;
 
+    /**
+     * Save the changes you have done into the repository. This will create a new version of the file or
+     * directory in the repository.
+     * <p>
+     * When the fileSet has no entries, the fileSet.getBaseDir() is recursively committed.
+     * When the fileSet has entries, the commit is non-recursive and only the elements in the fileSet
+     * are committed.
+     *
+     * @param repository  the source control system
+     * @param fileSet     the files to check in (sometimes called commit)
+     * @param parameters  {@link CommandParameters}
+     * @return TODO
+     * @throws ScmException if any
+     */
+    CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)
+            throws ScmException;
+
     /**
      * Save the changes you have done into the repository. This will create a new version of the file or
      * directory in the repository.

maven-scm-plugin/src/main/java/org/apache/maven/scm/plugin/TagMojo.java

@@ -107,6 +107,14 @@ public class TagMojo extends AbstractScmMojo {
     @Parameter(property = "sign", defaultValue = "false")
     private boolean sign;
 
+    /**
+     * Enable the "--no-sign" in Git
+     *
+     * @since 2.1.1
+     */
+    @Parameter(property = "forceNoSign", defaultValue = "false")
+    private boolean forceNoSign;
+
     @Inject
     public TagMojo(ScmManager manager, SettingsDecrypter settingsDecrypter) {
         super(manager, settingsDecrypter);
@@ -150,6 +158,7 @@ public void execute() throws MojoExecutionException {
             scmTagParameters.setRemoteTagging(remoteTagging);
             scmTagParameters.setPinExternals(pinExternals);
             scmTagParameters.setSign(sign);
+            scmTagParameters.setForceNoSign(forceNoSign);
 
             TagScmResult result = provider.tag(repository, getFileSet(), finalTag, scmTagParameters);
 
@@ -158,4 +167,20 @@ public void execute() throws MojoExecutionException {
             throw new MojoExecutionException("Cannot run tag command : ", e);
         }
     }
+
+    public boolean isSign() {
+        return sign;
+    }
+
+    public void setSign(boolean sign) {
+        this.sign = sign;
+    }
+
+    public boolean isForceNoSign() {
+        return forceNoSign;
+    }
+
+    public void setForceNoSign(boolean forceNoSign) {
+        this.forceNoSign = forceNoSign;
+    }
 }

maven-scm-plugin/src/test/java/org/apache/maven/scm/plugin/UntagMojoTest.java

@@ -72,6 +72,8 @@ public void testUntag() throws Exception {
 
         TagMojo tagMojo = (TagMojo) lookupMojo("tag", getTestFile("src/test/resources/mojos/untag/tag.xml"));
         tagMojo.setWorkingDirectory(checkoutDir);
+        tagMojo.setSign(false);
+        tagMojo.setForceNoSign(true);
         tagMojo.setConnectionUrl(getConnectionLocalAddress(tagMojo));
         tagMojo.execute();
 

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/java/org/apache/maven/scm/provider/git/AbstractGitScmProvider.java

@@ -186,6 +186,12 @@ public CheckInScmResult checkin(ScmProviderRepository repository, ScmFileSet fil
         return (CheckInScmResult) executeCommand(getCheckInCommand(), repository, fileSet, parameters);
     }
 
+    @Override
+    public CheckInScmResult checkIn(ScmRepository repository, ScmFileSet fileSet, CommandParameters parameters)
+            throws ScmException {
+        return (CheckInScmResult) getCheckInCommand().execute(repository.getProviderRepository(), fileSet, parameters);
+    }
+
     protected abstract GitCommand getCheckOutCommand();
 
     /** {@inheritDoc} */