4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5 * Carlos Rica <jasampler@gmail.com>
6 * Based on git-tag.sh and mktag.c by Linus Torvalds.
13 #include "environment.h"
17 #include "object-name.h"
18 #include "object-store-ll.h"
21 #include "parse-options.h"
24 #include "gpg-interface.h"
25 #include "oid-array.h"
27 #include "ref-filter.h"
29 #include "write-or-die.h"
30 #include "object-file-convert.h"
32 static const char * const git_tag_usage
[] = {
33 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] [-e]\n"
34 " <tagname> [<commit> | <object>]"),
35 N_("git tag -d <tagname>..."),
36 N_("git tag [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]\n"
37 " [--points-at <object>] [--column[=<options>] | --no-column]\n"
38 " [--create-reflog] [--sort=<key>] [--format=<format>]\n"
39 " [--merged <commit>] [--no-merged <commit>] [<pattern>...]"),
40 N_("git tag -v [--format=<format>] <tagname>..."),
44 static unsigned int colopts
;
45 static int force_sign_annotate
;
46 static int config_sign_tag
= -1; /* unspecified */
48 static int list_tags(struct ref_filter
*filter
, struct ref_sorting
*sorting
,
49 struct ref_format
*format
)
53 if (filter
->lines
== -1)
56 if (!format
->format
) {
58 to_free
= xstrfmt("%s %%(contents:lines=%d)",
59 "%(align:15)%(refname:lstrip=2)%(end)",
61 format
->format
= to_free
;
63 format
->format
= "%(refname:lstrip=2)";
66 if (verify_ref_format(format
))
67 die(_("unable to parse format string"));
68 filter
->with_commit_tag_algo
= 1;
69 filter_and_format_refs(filter
, FILTER_REFS_TAGS
, sorting
, format
);
76 typedef int (*each_tag_name_fn
)(const char *name
, const char *ref
,
77 const struct object_id
*oid
, void *cb_data
);
79 static int for_each_tag_name(const char **argv
, each_tag_name_fn fn
,
83 struct strbuf ref
= STRBUF_INIT
;
87 for (p
= argv
; *p
; p
++) {
89 strbuf_addf(&ref
, "refs/tags/%s", *p
);
90 if (read_ref(ref
.buf
, &oid
)) {
91 error(_("tag '%s' not found."), *p
);
95 if (fn(*p
, ref
.buf
, &oid
, cb_data
))
102 static int collect_tags(const char *name UNUSED
, const char *ref
,
103 const struct object_id
*oid
, void *cb_data
)
105 struct string_list
*ref_list
= cb_data
;
107 string_list_append(ref_list
, ref
);
108 ref_list
->items
[ref_list
->nr
- 1].util
= oiddup(oid
);
112 static int delete_tags(const char **argv
)
115 struct string_list refs_to_delete
= STRING_LIST_INIT_DUP
;
116 struct string_list_item
*item
;
118 result
= for_each_tag_name(argv
, collect_tags
, (void *)&refs_to_delete
);
119 if (delete_refs(NULL
, &refs_to_delete
, REF_NO_DEREF
))
122 for_each_string_list_item(item
, &refs_to_delete
) {
123 const char *name
= item
->string
;
124 struct object_id
*oid
= item
->util
;
125 if (!ref_exists(name
))
126 printf(_("Deleted tag '%s' (was %s)\n"),
128 repo_find_unique_abbrev(the_repository
, oid
, DEFAULT_ABBREV
));
132 string_list_clear(&refs_to_delete
, 0);
136 static int verify_tag(const char *name
, const char *ref UNUSED
,
137 const struct object_id
*oid
, void *cb_data
)
140 struct ref_format
*format
= cb_data
;
141 flags
= GPG_VERIFY_VERBOSE
;
144 flags
= GPG_VERIFY_OMIT_STATUS
;
146 if (gpg_verify_tag(oid
, name
, flags
))
150 pretty_print_ref(name
, oid
, format
);
155 static int do_sign(struct strbuf
*buffer
, struct object_id
**compat_oid
,
156 struct object_id
*compat_oid_buf
)
158 const struct git_hash_algo
*compat
= the_repository
->compat_hash_algo
;
159 struct strbuf sig
= STRBUF_INIT
, compat_sig
= STRBUF_INIT
;
160 struct strbuf compat_buf
= STRBUF_INIT
;
161 const char *keyid
= get_signing_key();
164 if (sign_buffer(buffer
, &sig
, keyid
))
168 const struct git_hash_algo
*algo
= the_repository
->hash_algo
;
170 if (convert_object_file(&compat_buf
, algo
, compat
,
171 buffer
->buf
, buffer
->len
, OBJ_TAG
, 1))
173 if (sign_buffer(&compat_buf
, &compat_sig
, keyid
))
175 add_header_signature(&compat_buf
, &sig
, algo
);
176 strbuf_addbuf(&compat_buf
, &compat_sig
);
177 hash_object_file(compat
, compat_buf
.buf
, compat_buf
.len
,
178 OBJ_TAG
, compat_oid_buf
);
179 *compat_oid
= compat_oid_buf
;
183 add_header_signature(buffer
, &compat_sig
, compat
);
185 strbuf_addbuf(buffer
, &sig
);
188 strbuf_release(&sig
);
189 strbuf_release(&compat_sig
);
190 strbuf_release(&compat_buf
);
194 static const char tag_template
[] =
195 N_("\nWrite a message for tag:\n %s\n"
196 "Lines starting with '%s' will be ignored.\n");
198 static const char tag_template_nocleanup
[] =
199 N_("\nWrite a message for tag:\n %s\n"
200 "Lines starting with '%s' will be kept; you may remove them"
201 " yourself if you want to.\n");
203 static int git_tag_config(const char *var
, const char *value
,
204 const struct config_context
*ctx
, void *cb
)
206 if (!strcmp(var
, "tag.gpgsign")) {
207 config_sign_tag
= git_config_bool(var
, value
);
211 if (!strcmp(var
, "tag.sort")) {
213 return config_error_nonbool(var
);
214 string_list_append(cb
, value
);
218 if (!strcmp(var
, "tag.forcesignannotated")) {
219 force_sign_annotate
= git_config_bool(var
, value
);
223 if (starts_with(var
, "column."))
224 return git_column_config(var
, value
, "tag", &colopts
);
226 if (git_color_config(var
, value
, cb
) < 0)
229 return git_default_config(var
, value
, ctx
, cb
);
232 static void write_tag_body(int fd
, const struct object_id
*oid
)
235 enum object_type type
;
236 char *buf
, *sp
, *orig
;
237 struct strbuf payload
= STRBUF_INIT
;
238 struct strbuf signature
= STRBUF_INIT
;
240 orig
= buf
= repo_read_object_file(the_repository
, oid
, &type
, &size
);
243 if (parse_signature(buf
, size
, &payload
, &signature
)) {
248 sp
= strstr(buf
, "\n\n");
250 if (!sp
|| !size
|| type
!= OBJ_TAG
) {
254 sp
+= 2; /* skip the 2 LFs */
255 write_or_die(fd
, sp
, buf
+ size
- sp
);
258 strbuf_release(&payload
);
259 strbuf_release(&signature
);
262 static int build_tag_object(struct strbuf
*buf
, int sign
, struct object_id
*result
)
264 struct object_id
*compat_oid
= NULL
, compat_oid_buf
;
265 if (sign
&& do_sign(buf
, &compat_oid
, &compat_oid_buf
) < 0)
266 return error(_("unable to sign the tag"));
267 if (write_object_file_flags(buf
->buf
, buf
->len
, OBJ_TAG
, result
,
269 return error(_("unable to write tag file"));
273 struct create_tag_options
{
274 unsigned int message_given
:1;
275 unsigned int use_editor
:1;
284 static const char message_advice_nested_tag
[] =
285 N_("You have created a nested tag. The object referred to by your new tag is\n"
286 "already a tag. If you meant to tag the object that it points to, use:\n"
288 "\tgit tag -f %s %s^{}");
290 static void create_tag(const struct object_id
*object
, const char *object_ref
,
292 struct strbuf
*buf
, struct create_tag_options
*opt
,
293 struct object_id
*prev
, struct object_id
*result
, char *path
)
295 enum object_type type
;
296 struct strbuf header
= STRBUF_INIT
;
298 type
= oid_object_info(the_repository
, object
, NULL
);
299 if (type
<= OBJ_NONE
)
300 die(_("bad object type."));
303 advise_if_enabled(ADVICE_NESTED_TAG
, _(message_advice_nested_tag
),
314 git_committer_info(IDENT_STRICT
));
316 if (!opt
->message_given
|| opt
->use_editor
) {
319 /* write the template message before editing: */
320 fd
= xopen(path
, O_CREAT
| O_TRUNC
| O_WRONLY
, 0600);
322 if (opt
->message_given
) {
323 write_or_die(fd
, buf
->buf
, buf
->len
);
325 } else if (!is_null_oid(prev
)) {
326 write_tag_body(fd
, prev
);
328 struct strbuf buf
= STRBUF_INIT
;
329 strbuf_addch(&buf
, '\n');
330 if (opt
->cleanup_mode
== CLEANUP_ALL
)
331 strbuf_commented_addf(&buf
, comment_line_str
,
332 _(tag_template
), tag
, comment_line_str
);
334 strbuf_commented_addf(&buf
, comment_line_str
,
335 _(tag_template_nocleanup
), tag
, comment_line_str
);
336 write_or_die(fd
, buf
.buf
, buf
.len
);
337 strbuf_release(&buf
);
341 if (launch_editor(path
, buf
, NULL
)) {
343 _("Please supply the message using either -m or -F option.\n"));
348 if (opt
->cleanup_mode
!= CLEANUP_NONE
)
349 strbuf_stripspace(buf
,
350 opt
->cleanup_mode
== CLEANUP_ALL
? comment_line_str
: NULL
);
352 if (!opt
->message_given
&& !buf
->len
)
353 die(_("no tag message?"));
355 strbuf_insert(buf
, 0, header
.buf
, header
.len
);
356 strbuf_release(&header
);
358 if (build_tag_object(buf
, opt
->sign
, result
) < 0) {
360 fprintf(stderr
, _("The tag message has been left in %s\n"),
366 static void create_reflog_msg(const struct object_id
*oid
, struct strbuf
*sb
)
368 enum object_type type
;
373 const char *subject_start
;
375 char *rla
= getenv("GIT_REFLOG_ACTION");
377 strbuf_addstr(sb
, rla
);
379 strbuf_addstr(sb
, "tag: tagging ");
380 strbuf_add_unique_abbrev(sb
, oid
, DEFAULT_ABBREV
);
383 strbuf_addstr(sb
, " (");
384 type
= oid_object_info(the_repository
, oid
, NULL
);
387 strbuf_addstr(sb
, "object of unknown type");
390 if ((buf
= repo_read_object_file(the_repository
, oid
, &type
, &size
))) {
391 subject_len
= find_commit_subject(buf
, &subject_start
);
392 strbuf_insert(sb
, sb
->len
, subject_start
, subject_len
);
394 strbuf_addstr(sb
, "commit object");
398 if ((c
= lookup_commit_reference(the_repository
, oid
)))
399 strbuf_addf(sb
, ", %s", show_date(c
->date
, 0, DATE_MODE(SHORT
)));
402 strbuf_addstr(sb
, "tree object");
405 strbuf_addstr(sb
, "blob object");
408 strbuf_addstr(sb
, "other tag object");
411 strbuf_addch(sb
, ')');
419 static int parse_msg_arg(const struct option
*opt
, const char *arg
, int unset
)
421 struct msg_arg
*msg
= opt
->value
;
423 BUG_ON_OPT_NEG(unset
);
428 strbuf_addstr(&(msg
->buf
), "\n\n");
429 strbuf_addstr(&(msg
->buf
), arg
);
434 static int strbuf_check_tag_ref(struct strbuf
*sb
, const char *name
)
440 strbuf_addf(sb
, "refs/tags/%s", name
);
442 return check_refname_format(sb
->buf
, 0);
445 int cmd_tag(int argc
, const char **argv
, const char *prefix
)
447 struct strbuf buf
= STRBUF_INIT
;
448 struct strbuf ref
= STRBUF_INIT
;
449 struct strbuf reflog_msg
= STRBUF_INIT
;
450 struct object_id object
, prev
;
451 const char *object_ref
, *tag
;
452 struct create_tag_options opt
;
453 char *cleanup_arg
= NULL
;
454 int create_reflog
= 0;
455 int annotate
= 0, force
= 0;
456 int cmdmode
= 0, create_tag_object
= 0;
457 char *msgfile
= NULL
;
458 const char *keyid
= NULL
;
459 struct msg_arg msg
= { .buf
= STRBUF_INIT
};
460 struct ref_transaction
*transaction
;
461 struct strbuf err
= STRBUF_INIT
;
462 struct ref_filter filter
= REF_FILTER_INIT
;
463 struct ref_sorting
*sorting
;
464 struct string_list sorting_options
= STRING_LIST_INIT_DUP
;
465 struct ref_format format
= REF_FORMAT_INIT
;
468 struct option options
[] = {
469 OPT_CMDMODE('l', "list", &cmdmode
, N_("list tag names"), 'l'),
470 { OPTION_INTEGER
, 'n', NULL
, &filter
.lines
, N_("n"),
471 N_("print <n> lines of each tag message"),
472 PARSE_OPT_OPTARG
, NULL
, 1 },
473 OPT_CMDMODE('d', "delete", &cmdmode
, N_("delete tags"), 'd'),
474 OPT_CMDMODE('v', "verify", &cmdmode
, N_("verify tags"), 'v'),
476 OPT_GROUP(N_("Tag creation options")),
477 OPT_BOOL('a', "annotate", &annotate
,
478 N_("annotated tag, needs a message")),
479 OPT_CALLBACK_F('m', "message", &msg
, N_("message"),
480 N_("tag message"), PARSE_OPT_NONEG
, parse_msg_arg
),
481 OPT_FILENAME('F', "file", &msgfile
, N_("read message from file")),
482 OPT_BOOL('e', "edit", &edit_flag
, N_("force edit of tag message")),
483 OPT_BOOL('s', "sign", &opt
.sign
, N_("annotated and GPG-signed tag")),
484 OPT_CLEANUP(&cleanup_arg
),
485 OPT_STRING('u', "local-user", &keyid
, N_("key-id"),
486 N_("use another key to sign the tag")),
487 OPT__FORCE(&force
, N_("replace the tag if exists"), 0),
488 OPT_BOOL(0, "create-reflog", &create_reflog
, N_("create a reflog")),
490 OPT_GROUP(N_("Tag listing options")),
491 OPT_COLUMN(0, "column", &colopts
, N_("show tag list in columns")),
492 OPT_CONTAINS(&filter
.with_commit
, N_("print only tags that contain the commit")),
493 OPT_NO_CONTAINS(&filter
.no_commit
, N_("print only tags that don't contain the commit")),
494 OPT_WITH(&filter
.with_commit
, N_("print only tags that contain the commit")),
495 OPT_WITHOUT(&filter
.no_commit
, N_("print only tags that don't contain the commit")),
496 OPT_MERGED(&filter
, N_("print only tags that are merged")),
497 OPT_NO_MERGED(&filter
, N_("print only tags that are not merged")),
498 OPT_BOOL(0, "omit-empty", &format
.array_opts
.omit_empty
,
499 N_("do not output a newline after empty formatted refs")),
500 OPT_REF_SORT(&sorting_options
),
502 OPTION_CALLBACK
, 0, "points-at", &filter
.points_at
, N_("object"),
503 N_("print only tags of the object"), PARSE_OPT_LASTARG_DEFAULT
,
504 parse_opt_object_name
, (intptr_t) "HEAD"
506 OPT_STRING( 0 , "format", &format
.format
, N_("format"),
507 N_("format to use for the output")),
508 OPT__COLOR(&format
.use_color
, N_("respect format colors")),
509 OPT_BOOL('i', "ignore-case", &icase
, N_("sorting and filtering are case insensitive")),
513 const char *only_in_list
= NULL
;
516 setup_ref_filter_porcelain_msg();
519 * Try to set sort keys from config. If config does not set any,
520 * fall back on default (refname) sorting.
522 git_config(git_tag_config
, &sorting_options
);
523 if (!sorting_options
.nr
)
524 string_list_append(&sorting_options
, "refname");
526 memset(&opt
, 0, sizeof(opt
));
530 argc
= parse_options(argc
, argv
, prefix
, options
, git_tag_usage
, 0);
535 else if (filter
.with_commit
|| filter
.no_commit
||
536 filter
.reachable_from
|| filter
.unreachable_from
||
537 filter
.points_at
.nr
|| filter
.lines
!= -1)
542 setup_auto_pager("tag", 1);
545 opt
.sign
= cmdmode
? 0 : config_sign_tag
> 0;
549 set_signing_key(keyid
);
551 create_tag_object
= (opt
.sign
|| annotate
|| msg
.given
|| msgfile
);
553 if ((create_tag_object
|| force
) && (cmdmode
!= 0))
554 usage_with_options(git_tag_usage
, options
);
556 finalize_colopts(&colopts
, -1);
557 if (cmdmode
== 'l' && filter
.lines
!= -1) {
558 if (explicitly_enable_column(colopts
))
559 die(_("options '%s' and '%s' cannot be used together"), "--column", "-n");
562 sorting
= ref_sorting_options(&sorting_options
);
563 ref_sorting_set_sort_flags_all(sorting
, REF_SORTING_ICASE
, icase
);
564 filter
.ignore_case
= icase
;
565 if (cmdmode
== 'l') {
566 if (column_active(colopts
)) {
567 struct column_options copts
;
568 memset(&copts
, 0, sizeof(copts
));
570 if (run_column_filter(colopts
, &copts
))
571 die(_("could not start 'git column'"));
573 filter
.name_patterns
= argv
;
574 ret
= list_tags(&filter
, sorting
, &format
);
575 if (column_active(colopts
))
576 stop_column_filter();
579 if (filter
.lines
!= -1)
581 else if (filter
.with_commit
)
582 only_in_list
= "--contains";
583 else if (filter
.no_commit
)
584 only_in_list
= "--no-contains";
585 else if (filter
.points_at
.nr
)
586 only_in_list
= "--points-at";
587 else if (filter
.reachable_from
)
588 only_in_list
= "--merged";
589 else if (filter
.unreachable_from
)
590 only_in_list
= "--no-merged";
592 die(_("the '%s' option is only allowed in list mode"), only_in_list
);
593 if (cmdmode
== 'd') {
594 ret
= delete_tags(argv
);
597 if (cmdmode
== 'v') {
598 if (format
.format
&& verify_ref_format(&format
))
599 usage_with_options(git_tag_usage
, options
);
600 ret
= for_each_tag_name(argv
, verify_tag
, &format
);
604 if (msg
.given
|| msgfile
) {
605 if (msg
.given
&& msgfile
)
606 die(_("options '%s' and '%s' cannot be used together"), "-F", "-m");
608 strbuf_addbuf(&buf
, &(msg
.buf
));
610 if (!strcmp(msgfile
, "-")) {
611 if (strbuf_read(&buf
, 0, 1024) < 0)
612 die_errno(_("cannot read '%s'"), msgfile
);
614 if (strbuf_read_file(&buf
, msgfile
, 1024) < 0)
615 die_errno(_("could not open or read '%s'"),
623 object_ref
= argc
== 2 ? argv
[1] : "HEAD";
625 die(_("too many arguments"));
627 if (repo_get_oid(the_repository
, object_ref
, &object
))
628 die(_("Failed to resolve '%s' as a valid ref."), object_ref
);
630 if (strbuf_check_tag_ref(&ref
, tag
))
631 die(_("'%s' is not a valid tag name."), tag
);
633 if (read_ref(ref
.buf
, &prev
))
636 die(_("tag '%s' already exists"), tag
);
638 opt
.message_given
= msg
.given
|| msgfile
;
639 opt
.use_editor
= edit_flag
;
641 if (!cleanup_arg
|| !strcmp(cleanup_arg
, "strip"))
642 opt
.cleanup_mode
= CLEANUP_ALL
;
643 else if (!strcmp(cleanup_arg
, "verbatim"))
644 opt
.cleanup_mode
= CLEANUP_NONE
;
645 else if (!strcmp(cleanup_arg
, "whitespace"))
646 opt
.cleanup_mode
= CLEANUP_SPACE
;
648 die(_("Invalid cleanup mode %s"), cleanup_arg
);
650 create_reflog_msg(&object
, &reflog_msg
);
652 if (create_tag_object
) {
653 if (force_sign_annotate
&& !annotate
)
655 path
= git_pathdup("TAG_EDITMSG");
656 create_tag(&object
, object_ref
, tag
, &buf
, &opt
, &prev
, &object
,
660 transaction
= ref_transaction_begin(&err
);
662 ref_transaction_update(transaction
, ref
.buf
, &object
, &prev
,
663 create_reflog
? REF_FORCE_CREATE_REFLOG
: 0,
664 reflog_msg
.buf
, &err
) ||
665 ref_transaction_commit(transaction
, &err
)) {
668 _("The tag message has been left in %s\n"),
673 unlink_or_warn(path
);
676 ref_transaction_free(transaction
);
677 if (force
&& !is_null_oid(&prev
) && !oideq(&prev
, &object
))
678 printf(_("Updated tag '%s' (was %s)\n"), tag
,
679 repo_find_unique_abbrev(the_repository
, &prev
, DEFAULT_ABBREV
));
682 ref_sorting_release(sorting
);
683 ref_filter_clear(&filter
);
684 strbuf_release(&buf
);
685 strbuf_release(&ref
);
686 strbuf_release(&reflog_msg
);
687 strbuf_release(&msg
.buf
);
688 strbuf_release(&err
);