mirror of
https://github.com/git/git.git
synced 2024-12-12 03:14:11 +08:00
commit: add --trailer option
Historically, Git has supported the 'Signed-off-by' commit trailer using the '--signoff' and the '-s' option from the command line. But users may need to provide other trailer information from the command line such as "Helped-by", "Reported-by", "Mentored-by", Now implement a new `--trailer <token>[(=|:)<value>]` option to pass other trailers to `interpret-trailers` and insert them into commit messages. Signed-off-by: ZheNing Hu <adlternative@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
ZheNing Hu
Junio C Hamano
parent
1424303384
commit
2daae3d1d1
@ -14,7 +14,8 @@ SYNOPSIS
|
||||
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
|
||||
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
|
||||
[-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
|
||||
[-S[<keyid>]] [--] [<pathspec>...]
|
||||
[(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]
|
||||
[--] [<pathspec>...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
@ -166,6 +167,17 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
|
||||
|
||||
include::signoff-option.txt[]
|
||||
|
||||
--trailer <token>[(=|:)<value>]::
|
||||
Specify a (<token>, <value>) pair that should be applied as a
|
||||
trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
|
||||
<committer@example.com>" --trailer "Helped-by:C O Mitter \
|
||||
<committer@example.com>"` will add the "Signed-off-by" trailer
|
||||
and the "Helped-by" trailer to the commit message.)
|
||||
The `trailer.*` configuration variables
|
||||
(linkgit:git-interpret-trailers[1]) can be used to define if
|
||||
a duplicated trailer is omitted, where in the run of trailers
|
||||
each trailer would appear, and other details.
|
||||
|
||||
-n::
|
||||
--no-verify::
|
||||
This option bypasses the pre-commit and commit-msg hooks.
|
||||
|
||||
@ -113,6 +113,7 @@ static int config_commit_verbose = -1; /* unspecified */
|
||||
static int no_post_rewrite, allow_empty_message, pathspec_file_nul;
|
||||
static char *untracked_files_arg, *force_date, *ignore_submodule_arg, *ignored_arg;
|
||||
static char *sign_commit, *pathspec_from_file;
|
||||
static struct strvec trailer_args = STRVEC_INIT;
|
||||
|
||||
/*
|
||||
* The default commit message cleanup mode will remove the lines
|
||||
@ -131,6 +132,14 @@ static struct strbuf message = STRBUF_INIT;
|
||||
|
||||
static enum wt_status_format status_format = STATUS_FORMAT_UNSPECIFIED;
|
||||
|
||||
static int opt_pass_trailer(const struct option *opt, const char *arg, int unset)
|
||||
{
|
||||
BUG_ON_OPT_NEG(unset);
|
||||
|
||||
strvec_pushl(&trailer_args, "--trailer", arg, NULL);
|
||||
return 0;
|
||||
}
|
||||
|
||||
static int opt_parse_porcelain(const struct option *opt, const char *arg, int unset)
|
||||
{
|
||||
enum wt_status_format *value = (enum wt_status_format *)opt->value;
|
||||
@ -958,6 +967,18 @@ static int prepare_to_commit(const char *index_file, const char *prefix,
|
||||
|
||||
fclose(s->fp);
|
||||
|
||||
if (trailer_args.nr) {
|
||||
struct child_process run_trailer = CHILD_PROCESS_INIT;
|
||||
|
||||
strvec_pushl(&run_trailer.args, "interpret-trailers",
|
||||
"--in-place", git_path_commit_editmsg(), NULL);
|
||||
strvec_pushv(&run_trailer.args, trailer_args.v);
|
||||
run_trailer.git_cmd = 1;
|
||||
if (run_command(&run_trailer))
|
||||
die(_("unable to pass trailers to --trailers"));
|
||||
strvec_clear(&trailer_args);
|
||||
}
|
||||
|
||||
/*
|
||||
* Reject an attempt to record a non-merge empty commit without
|
||||
* explicit --allow-empty. In the cherry-pick case, it may be
|
||||
@ -1507,6 +1528,7 @@ int cmd_commit(int argc, const char **argv, const char *prefix)
|
||||
OPT_STRING(0, "fixup", &fixup_message, N_("commit"), N_("use autosquash formatted message to fixup specified commit")),
|
||||
OPT_STRING(0, "squash", &squash_message, N_("commit"), N_("use autosquash formatted message to squash specified commit")),
|
||||
OPT_BOOL(0, "reset-author", &renew_authorship, N_("the commit is authored by me now (used with -C/-c/--amend)")),
|
||||
OPT_CALLBACK_F(0, "trailer", NULL, N_("trailer"), N_("add custom trailer(s)"), PARSE_OPT_NONEG, opt_pass_trailer),
|
||||
OPT_BOOL('s', "signoff", &signoff, N_("add a Signed-off-by trailer")),
|
||||
OPT_FILENAME('t', "template", &template_file, N_("use specified template file")),
|
||||
OPT_BOOL('e', "edit", &edit_flag, N_("force edit of commit")),
|
||||
|
||||
@ -38,6 +38,16 @@ check_summary_oneline() {
|
||||
test_cmp exp act
|
||||
}
|
||||
|
||||
trailer_commit_base () {
|
||||
echo "fun" >>file &&
|
||||
git add file &&
|
||||
git commit -s --trailer "Signed-off-by=C1 E1 " \
|
||||
--trailer "Helped-by:C2 E2 " \
|
||||
--trailer "Reported-by=C3 E3" \
|
||||
--trailer "Mentored-by:C4 E4" \
|
||||
-m "hello"
|
||||
}
|
||||
|
||||
test_expect_success 'output summary format' '
|
||||
|
||||
echo new >file1 &&
|
||||
@ -154,6 +164,308 @@ test_expect_success 'sign off' '
|
||||
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with "="' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
EOF
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "replace" as ifexists' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Helped-by: C3 E3
|
||||
EOF
|
||||
git -c trailer.ifexists="replace" \
|
||||
commit --trailer "Mentored-by: C4 E4" \
|
||||
--trailer "Helped-by: C3 E3" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "add" as ifexists' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
EOF
|
||||
git -c trailer.ifexists="add" \
|
||||
commit --trailer "Reported-by: C3 E3" \
|
||||
--trailer "Mentored-by: C4 E4" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "donothing" as ifexists' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Reviewed-by: C6 E6
|
||||
EOF
|
||||
git -c trailer.ifexists="donothing" \
|
||||
commit --trailer "Mentored-by: C5 E5" \
|
||||
--trailer "Reviewed-by: C6 E6" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "addIfDifferent" as ifexists' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Mentored-by: C5 E5
|
||||
EOF
|
||||
git -c trailer.ifexists="addIfDifferent" \
|
||||
commit --trailer "Reported-by: C3 E3" \
|
||||
--trailer "Mentored-by: C5 E5" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "addIfDifferentNeighbor" as ifexists' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Reported-by: C3 E3
|
||||
EOF
|
||||
git -c trailer.ifexists="addIfDifferentNeighbor" \
|
||||
commit --trailer "Mentored-by: C4 E4" \
|
||||
--trailer "Reported-by: C3 E3" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "end" as where' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
EOF
|
||||
git -c trailer.where="end" \
|
||||
commit --trailer "Reported-by: C3 E3" \
|
||||
--trailer "Mentored-by: C4 E4" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "start" as where' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C1 E1
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
EOF
|
||||
git -c trailer.where="start" \
|
||||
commit --trailer "Signed-off-by: C O Mitter <committer@example.com>" \
|
||||
--trailer "Signed-off-by: C1 E1" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "after" as where' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Mentored-by: C5 E5
|
||||
EOF
|
||||
git -c trailer.where="after" \
|
||||
commit --trailer "Mentored-by: C4 E4" \
|
||||
--trailer "Mentored-by: C5 E5" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "before" as where' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C2 E2
|
||||
Mentored-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
EOF
|
||||
git -c trailer.where="before" \
|
||||
commit --trailer "Mentored-by: C3 E3" \
|
||||
--trailer "Mentored-by: C2 E2" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "donothing" as ifmissing' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Helped-by: C5 E5
|
||||
EOF
|
||||
git -c trailer.ifmissing="donothing" \
|
||||
commit --trailer "Helped-by: C5 E5" \
|
||||
--trailer "Based-by: C6 E6" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and "add" as ifmissing' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Reported-by: C3 E3
|
||||
Mentored-by: C4 E4
|
||||
Helped-by: C5 E5
|
||||
Based-by: C6 E6
|
||||
EOF
|
||||
git -c trailer.ifmissing="add" \
|
||||
commit --trailer "Helped-by: C5 E5" \
|
||||
--trailer "Based-by: C6 E6" \
|
||||
--amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c ack.key ' '
|
||||
echo "fun" >>file1 &&
|
||||
git add file1 &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Acked-by: Peff
|
||||
EOF
|
||||
git -c trailer.ack.key="Acked-by" \
|
||||
commit --trailer "ack = Peff" -m "hello" &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and ":=#" as separators' '
|
||||
echo "fun" >>file1 &&
|
||||
git add file1 &&
|
||||
cat >expected <<-\EOF &&
|
||||
I hate bug
|
||||
|
||||
Bug #42
|
||||
EOF
|
||||
git -c trailer.separators=":=#" \
|
||||
-c trailer.bug.key="Bug #" \
|
||||
commit --trailer "bug = 42" -m "I hate bug" &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'commit --trailer with -c and command' '
|
||||
trailer_commit_base &&
|
||||
cat >expected <<-\EOF &&
|
||||
hello
|
||||
|
||||
Signed-off-by: C O Mitter <committer@example.com>
|
||||
Signed-off-by: C1 E1
|
||||
Helped-by: C2 E2
|
||||
Mentored-by: C4 E4
|
||||
Reported-by: A U Thor <author@example.com>
|
||||
EOF
|
||||
git -c trailer.report.key="Reported-by: " \
|
||||
-c trailer.report.ifexists="replace" \
|
||||
-c trailer.report.command="NAME=\"\$ARG\"; test -n \"\$NAME\" && \
|
||||
git log --author=\"\$NAME\" -1 --format=\"format:%aN <%aE>\" || true" \
|
||||
commit --trailer "report = author" --amend &&
|
||||
git cat-file commit HEAD >commit.msg &&
|
||||
sed -e "1,/^\$/d" commit.msg >actual &&
|
||||
test_cmp expected actual
|
||||
'
|
||||
|
||||
test_expect_success 'multiple -m' '
|
||||
|
||||
>negative &&
|
||||
|
||||
Loading…
Reference in New Issue
Block a user