Add signing options to commit CLI
Bug: 382212 Change-Id: I02194fc566dd5baa963424b1bac78607964436a3 Also-by: Gunnar Wagenknecht <gunnar@wagenknecht.org> Signed-off-by: Medha Bhargav Prabhala <mprabhala@salesforce.com> Signed-off-by: Gunnar Wagenknecht <gunnar@wagenknecht.org>
This commit is contained in:
parent
2343c688b1
commit
9150f5d836
|
@ -49,6 +49,7 @@
|
||||||
import org.eclipse.jgit.lib.Constants;
|
import org.eclipse.jgit.lib.Constants;
|
||||||
import org.eclipse.jgit.lib.Ref;
|
import org.eclipse.jgit.lib.Ref;
|
||||||
import org.eclipse.jgit.pgm.internal.CLIText;
|
import org.eclipse.jgit.pgm.internal.CLIText;
|
||||||
|
import org.eclipse.jgit.pgm.opt.GpgSignHandler;
|
||||||
import org.eclipse.jgit.revwalk.RevCommit;
|
import org.eclipse.jgit.revwalk.RevCommit;
|
||||||
import org.eclipse.jgit.util.RawParseUtils;
|
import org.eclipse.jgit.util.RawParseUtils;
|
||||||
import org.kohsuke.args4j.Argument;
|
import org.kohsuke.args4j.Argument;
|
||||||
|
@ -74,6 +75,13 @@ class Commit extends TextBuiltin {
|
||||||
@Option(name = "--amend", usage = "usage_CommitAmend")
|
@Option(name = "--amend", usage = "usage_CommitAmend")
|
||||||
private boolean amend;
|
private boolean amend;
|
||||||
|
|
||||||
|
@Option(name = "--gpg-sign", aliases = { "-S" }, forbids = {
|
||||||
|
"--no-gpg-sign" }, handler = GpgSignHandler.class)
|
||||||
|
private String gpgSigningKey;
|
||||||
|
|
||||||
|
@Option(name = "--no-gpg-sign", forbids = { "--gpg-sign" })
|
||||||
|
private boolean noGpgSign;
|
||||||
|
|
||||||
@Argument(metaVar = "metaVar_commitPaths", usage = "usage_CommitPaths")
|
@Argument(metaVar = "metaVar_commitPaths", usage = "usage_CommitPaths")
|
||||||
private List<String> paths = new ArrayList<>();
|
private List<String> paths = new ArrayList<>();
|
||||||
|
|
||||||
|
@ -87,6 +95,14 @@ protected void run() throws NoHeadException, NoMessageException,
|
||||||
commitCmd.setAuthor(RawParseUtils.parsePersonIdent(author));
|
commitCmd.setAuthor(RawParseUtils.parsePersonIdent(author));
|
||||||
if (message != null)
|
if (message != null)
|
||||||
commitCmd.setMessage(message);
|
commitCmd.setMessage(message);
|
||||||
|
if (noGpgSign) {
|
||||||
|
commitCmd.setSign(Boolean.FALSE);
|
||||||
|
} else if (gpgSigningKey != null) {
|
||||||
|
commitCmd.setSign(Boolean.TRUE);
|
||||||
|
if (!gpgSigningKey.equals(GpgSignHandler.DEFAULT)) {
|
||||||
|
commitCmd.setSigningKey(gpgSigningKey);
|
||||||
|
}
|
||||||
|
}
|
||||||
if (only && paths.isEmpty())
|
if (only && paths.isEmpty())
|
||||||
throw die(CLIText.get().pathsRequired);
|
throw die(CLIText.get().pathsRequired);
|
||||||
if (only && all)
|
if (only && all)
|
||||||
|
|
|
@ -0,0 +1,114 @@
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2018, Salesforce.
|
||||||
|
* and other copyright owners as documented in the project's IP log.
|
||||||
|
*
|
||||||
|
* This program and the accompanying materials are made available
|
||||||
|
* under the terms of the Eclipse Distribution License v1.0 which
|
||||||
|
* accompanies this distribution, is reproduced below, and is
|
||||||
|
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||||
|
*
|
||||||
|
* All rights reserved.
|
||||||
|
*
|
||||||
|
* Redistribution and use in source and binary forms, with or
|
||||||
|
* without modification, are permitted provided that the following
|
||||||
|
* conditions are met:
|
||||||
|
*
|
||||||
|
* - Redistributions of source code must retain the above copyright
|
||||||
|
* notice, this list of conditions and the following disclaimer.
|
||||||
|
*
|
||||||
|
* - Redistributions in binary form must reproduce the above
|
||||||
|
* copyright notice, this list of conditions and the following
|
||||||
|
* disclaimer in the documentation and/or other materials provided
|
||||||
|
* with the distribution.
|
||||||
|
*
|
||||||
|
* - Neither the name of the Eclipse Foundation, Inc. nor the
|
||||||
|
* names of its contributors may be used to endorse or promote
|
||||||
|
* products derived from this software without specific prior
|
||||||
|
* written permission.
|
||||||
|
*
|
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||||
|
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||||||
|
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||||
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
||||||
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||||||
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||||
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||||
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||||
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||||
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
*/
|
||||||
|
package org.eclipse.jgit.pgm.opt;
|
||||||
|
|
||||||
|
import org.kohsuke.args4j.CmdLineException;
|
||||||
|
import org.kohsuke.args4j.CmdLineParser;
|
||||||
|
import org.kohsuke.args4j.OptionDef;
|
||||||
|
import org.kohsuke.args4j.spi.Parameters;
|
||||||
|
import org.kohsuke.args4j.spi.Setter;
|
||||||
|
import org.kohsuke.args4j.spi.StringOptionHandler;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Special handler for the <code>--gpg-sign</code> option of the
|
||||||
|
* <code>commit</code> command.
|
||||||
|
*
|
||||||
|
* The following rules apply:
|
||||||
|
* <ul>
|
||||||
|
* <li>If no key is given, i.e. just <code>--gpg-sign</code> is passed, then it
|
||||||
|
* is the same as <code>--gpg-sign=default</code></li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* @since 5.3
|
||||||
|
*/
|
||||||
|
public class GpgSignHandler extends StringOptionHandler {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The value "default" which will be used when just the option is specified
|
||||||
|
* without any argument
|
||||||
|
*/
|
||||||
|
public static final String DEFAULT = "default"; //$NON-NLS-1$
|
||||||
|
|
||||||
|
/**
|
||||||
|
* <p>
|
||||||
|
* Constructor for GpgSignHandler.
|
||||||
|
* </p>
|
||||||
|
*
|
||||||
|
* @param parser
|
||||||
|
* The parser to which this handler belongs.
|
||||||
|
* @param option
|
||||||
|
* The annotation.
|
||||||
|
* @param setter
|
||||||
|
* Object to be used for setting value.
|
||||||
|
*/
|
||||||
|
public GpgSignHandler(CmdLineParser parser, OptionDef option,
|
||||||
|
Setter<? super String> setter) {
|
||||||
|
super(parser, option, setter);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** {@inheritDoc} */
|
||||||
|
@Override
|
||||||
|
public int parseArguments(Parameters params) throws CmdLineException {
|
||||||
|
String alias = params.getParameter(-1);
|
||||||
|
if ("--gpg-sign".equals(alias) || "-S".equals(alias)) { //$NON-NLS-1$ //$NON-NLS-2$
|
||||||
|
try {
|
||||||
|
String key = params.getParameter(0);
|
||||||
|
if (key == null || key.startsWith("-")) { //$NON-NLS-1$
|
||||||
|
// ignore invalid values and assume default
|
||||||
|
setter.addValue(DEFAULT);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// use what we have
|
||||||
|
setter.addValue(key);
|
||||||
|
return 1;
|
||||||
|
} catch (CmdLineException e) {
|
||||||
|
// no additional value, assume default
|
||||||
|
setter.addValue(DEFAULT);
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
Loading…
Reference in New Issue