From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Tigran Mkrtchyan <tigran.mkrtchyan@desy.de>
Cc: git@vger.kernel.org, jrnieder@gmail.com
Subject: Re: [PATCH v2] tag: add tag.gpgSign config option to force all tags be GPG-signed
Date: Tue, 4 Jun 2019 16:33:08 +0200 (CEST) [thread overview]
Message-ID: <nycvar.QRO.7.76.6.1906041608570.1775@tvgsbejvaqbjf.bet> (raw)
In-Reply-To: <20190604114356.11042-2-tigran.mkrtchyan@desy.de>
Hi Tigran,
On Tue, 4 Jun 2019, Tigran Mkrtchyan wrote:
> As may CI/CD tools don't allow to control command line options when
s/may/many/, maybe?
> executing `git tag` command, a default value in the configuration file
> will allow to enforce tag signing if required.
>
> The new config-file option tag.gpgSign enforces signed tags. Additional
> command line option --no-gpg-sign is added to disable such behavior if
> needed. E.g.:
>
> $ git tag -m "commit message"
>
> will generate a GPG signed tag if tag.gpgSign option is true, while
>
> $ git tag --no-gpg-sign -m "commit message"
>
> will skip the signing step.
>
> Signed-off-by: Tigran Mkrtchyan <tigran.mkrtchyan@desy.de>
> ---
> Documentation/git-tag.txt | 7 +++++++
> builtin/tag.c | 18 +++++++++++++++---
How about adding a section to Documentation/config/tag.txt as well?
Even better: it could be modeled after the description of commit.gpgsign
to which Stefan Beller linked in his review of your earlier patch (see
https://public-inbox.org/git/20131105112840.GZ4589@mars-attacks.org/):
tag.gpgsign::
A boolean to specify whether all tags should be GPG signed.
Use of this option when running in an automated script can
result in a large number of tags being signed. It is therefore
convenient to use an agent to avoid typing your gpg passphrase
several times.
> t/t7004-tag.sh | 21 +++++++++++++++++++++
> 3 files changed, 43 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
> index a74e7b926d..d9dbfb4e37 100644
> --- a/Documentation/git-tag.txt
> +++ b/Documentation/git-tag.txt
> @@ -64,6 +64,9 @@ OPTIONS
> -s::
> --sign::
> Make a GPG-signed tag, using the default e-mail address's key.
> + The default behabior of tag GPG-signing controlled by `tag.gpgSign`
s/behabior/behavior/ maybe?
And I would also insert an "is" before "controlled".
> + configuration variable if it exists, or disabled oder otherwise.
> + See linkgit:git-config[1].
>
> -u <keyid>::
> --local-user=<keyid>::
> @@ -193,6 +196,10 @@ This option is only applicable when listing tags without annotation lines.
> that of linkgit:git-for-each-ref[1]. When unspecified,
> defaults to `%(refname:strip=2)`.
>
> +--no-gpg-sign::
Should this not be `--no-sign`? There is already a `--sign` option, and I
would wager a guess that it automagically handles `--no-sign`...
> + Countermand `tag.gpgSign` configuration variable that is
> + set to force each and every tag to be signed.
If you replace "Countermand" by "Override", you could simply merge this
into the section talking about `--sign`...
> diff --git a/builtin/tag.c b/builtin/tag.c
> index ef37dccf86..7f9aef4840 100644
> --- a/builtin/tag.c
> +++ b/builtin/tag.c
> @@ -33,6 +33,7 @@ static const char * const git_tag_usage[] = {
>
> static unsigned int colopts;
> static int force_sign_annotate;
> +static int sign_tag;
Since this holds the value parsed from the config, I would like to see
some indication of that in the name. Maybe something like
`config_sign_tag`?
Also, I would recommend to initialize it with `-1` to be able to discern
between the three states `true`, `false` and `unspecified`.
> static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting,
> struct ref_format *format)
> @@ -144,6 +145,11 @@ static int git_tag_config(const char *var, const char *value, void *cb)
> int status;
> struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
>
> + if (!strcmp(var, "tag.gpgsign")) {
> + sign_tag = git_config_bool(var, value);
> + return 0;
> + }
> +
> if (!strcmp(var, "tag.sort")) {
> if (!value)
> return config_error_nonbool(var);
> @@ -392,6 +398,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
> struct ref_format format = REF_FORMAT_INIT;
> int icase = 0;
> int edit_flag = 0;
> + int no_gpg_sign = 0;
> struct option options[] = {
> OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
> { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
> @@ -413,6 +420,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
> N_("use another key to sign the tag")),
> OPT__FORCE(&force, N_("replace the tag if exists"), 0),
> OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
> + OPT_BOOL(0, "no-gpg-sign", &no_gpg_sign, N_("do not GPG-sign tag")),
>
> OPT_GROUP(N_("Tag listing options")),
> OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
> @@ -445,6 +453,10 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
>
> argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
>
> + if (no_gpg_sign) {
> + sign_tag = 0;
> + }
> +
Hmm. I'd rather like to see this folded into the `--no-sign` option
implied by the `OPT_BOOL('s', "sign", ...)` part. The way this would work
would be to initialize the struct like this:
struct create_tag_options opt = { .sign = -1 };
then leave
OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
as-is, and later do this:
if (opt.sign < 0)
opt.sign = config_sign_tag > 0;
> @@ -463,7 +475,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
> if (cmdmode == 'l')
> setup_auto_pager("tag", 1);
>
> - if ((create_tag_object || force) && (cmdmode != 0))
> + if ((create_tag_object || force || no_gpg_sign) && (cmdmode != 0))
> usage_with_options(git_tag_usage, options);
Should we really try to be that strict? If so, we would have to test for
`opt.sign > 0` here and make sure that above-mentioned `if (opt.sign < 0)`
block comes *after* this block.
> @@ -556,8 +568,8 @@ int cmd_tag(int argc, const char **argv, const char *prefix)
>
> create_reflog_msg(&object, &reflog_msg);
>
> - if (create_tag_object) {
> - if (force_sign_annotate && !annotate)
> + if (create_tag_object || sign_tag) {
> + if (sign_tag || (force_sign_annotate && !annotate))
> opt.sign = 1;
This would probably be better handled via
- create_tag_object = (opt.sign || annotate || msg.given || msgfile);
+ create_tag_object = (opt.sign > 0 || config_sign_tag > 0 ||
+ annotate || msg.given || msgfile);
earlier. After all, this assignment of `create_tag_object` suggests that
it is a Boolean that catches *all* cases where a tag should be created.
But then, we would have to be very careful about this, as we don't want to
error out when a user calls `git tag -l` while `tag.gpgSign = true`. So
maybe instead:
- create_tag_object = (opt.sign || annotate || msg.given || msgfile);
+ create_tag_object = (opt.sign > 0 || annotate || msg.given || msgfile);
and later, after that test whether `(create_tag_object || force) &&
cmd_mode != 0` do:
if (opt.sign < 0) {
opt.sign = config_sign_tag > 0;
create_tag_object ||= opt.sign;
> diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh
> index 6aeeb279a0..98a07a29d2 100755
> --- a/t/t7004-tag.sh
> +++ b/t/t7004-tag.sh
> @@ -932,6 +932,27 @@ test_expect_success GPG \
> test_cmp expect actual
> '
>
> +get_tag_header gpgsign-enabled $commit commit $time >expect
> +echo "A message" >>expect
> +echo '-----BEGIN PGP SIGNATURE-----' >>expect
> +test_expect_success GPG \
> + 'git tag configured tag.gpgsign enables GPG sign' \
> + 'test_config tag.gpgsign true &&
> + git tag -m "A message" gpgsign-enabled &&
> + get_tag_msg gpgsign-enabled>actual &&
> + test_cmp expect actual
> +'
> +
> +get_tag_header no-gpg-sign $commit commit $time >expect
> +echo "A message" >>expect
> +test_expect_success GPG \
> + 'git tag --no-gpg-sign configured tag.gpgsign skip GPG sign' \
> + 'test_config tag.gpgsign true &&
> + git tag -a --no-gpg-sign -m "A message" no-gpg-sign &&
With my idea above, this would of course become `--no-sign`.
> + get_tag_msg no-gpg-sign>actual &&
> + test_cmp expect actual
> +'
> +
> test_expect_success GPG \
> 'trying to create a signed tag with non-existing -F file should fail' '
> ! test -f nonexistingfile &&
Apart from the things I suggested in the hope to help you improve the
patch, this looks good to me so far.
Thanks,
Johannes
next prev parent reply other threads:[~2019-06-04 14:33 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <60741736.3439901.1509090074292.JavaMail.zimbra@desy.de>
2019-06-04 11:43 ` config option to force all tags be GPG-signed - comeback Tigran Mkrtchyan
2019-06-04 11:43 ` [PATCH v2] tag: add tag.gpgSign config option to force all tags be GPG-signed Tigran Mkrtchyan
2019-06-04 14:33 ` Johannes Schindelin [this message]
2019-06-04 16:04 ` Mkrtchyan, Tigran
2019-06-05 15:53 ` [PATCH v3] " Tigran Mkrtchyan
2019-06-05 16:21 ` Todd Zullinger
2019-06-05 16:25 ` Junio C Hamano
2019-06-05 20:12 ` Mkrtchyan, Tigran
2019-06-05 20:46 ` Junio C Hamano
2019-06-05 20:50 ` Mkrtchyan, Tigran
2019-06-05 20:57 ` Junio C Hamano
2019-06-05 21:09 ` Mkrtchyan, Tigran
2019-06-05 21:33 ` [PATCH v4] " Tigran Mkrtchyan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=nycvar.QRO.7.76.6.1906041608570.1775@tvgsbejvaqbjf.bet \
--to=johannes.schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=tigran.mkrtchyan@desy.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).