blob: 9919b03b2d601a74639553e8e61baef04ffd7cd9 [file] [log] [blame]
Carlos Rica62e09ce2007-07-20 01:42:28 +02001/*
2 * Builtin "git tag"
3 *
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.
7 */
8
9#include "cache.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -070010#include "config.h"
Carlos Rica62e09ce2007-07-20 01:42:28 +020011#include "builtin.h"
12#include "refs.h"
Stefan Bellercbd53a22018-05-15 16:42:15 -070013#include "object-store.h"
Carlos Rica62e09ce2007-07-20 01:42:28 +020014#include "tag.h"
15#include "run-command.h"
Carlos Rica39686582007-11-09 14:42:56 +010016#include "parse-options.h"
Jeff Kingffc4b802011-06-11 19:04:08 +000017#include "diff.h"
18#include "revision.h"
Junio C Hamano2f47eae2011-09-07 21:19:47 -070019#include "gpg-interface.h"
Tom Grennanae7706b2012-02-08 15:03:43 -080020#include "sha1-array.h"
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +070021#include "column.h"
Karthik Nayakac4cc862015-09-10 21:18:27 +053022#include "ref-filter.h"
Carlos Rica62e09ce2007-07-20 01:42:28 +020023
Carlos Rica39686582007-11-09 14:42:56 +010024static const char * const git_tag_usage[] = {
Alex Henrie9c9b4f22015-01-13 00:44:47 -070025 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <tagname> [<head>]"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +070026 N_("git tag -d <tagname>..."),
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +000027 N_("git tag -l [-n[<num>]] [--contains <commit>] [--no-contains <commit>] [--points-at <object>]"
Karthik Nayak52428602015-09-10 21:52:49 +053028 "\n\t\t[--format=<format>] [--[no-]merged [<commit>]] [<pattern>...]"),
Lukas Puehringer07d347c2017-01-17 18:37:21 -050029 N_("git tag -v [--format=<format>] <tagname>..."),
Carlos Rica39686582007-11-09 14:42:56 +010030 NULL
31};
Carlos Rica62e09ce2007-07-20 01:42:28 +020032
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +070033static unsigned int colopts;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +010034static int force_sign_annotate;
Tom Grennanae7706b2012-02-08 15:03:43 -080035
Jeff King4a68e362017-07-13 11:01:18 -040036static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting,
37 struct ref_format *format)
Jeff King588d0e82011-06-20 12:59:28 -040038{
Karthik Nayakac4cc862015-09-10 21:18:27 +053039 struct ref_array array;
Karthik Nayakdf094742015-09-11 20:36:46 +053040 char *to_free = NULL;
Jeff Kingca516992012-02-06 03:13:12 -050041 int i;
Jeff Kingca516992012-02-06 03:13:12 -050042
Karthik Nayakac4cc862015-09-10 21:18:27 +053043 memset(&array, 0, sizeof(array));
Jeff Kingca516992012-02-06 03:13:12 -050044
Karthik Nayakac4cc862015-09-10 21:18:27 +053045 if (filter->lines == -1)
46 filter->lines = 0;
Junio C Hamano31fd8d72012-02-06 10:13:27 -080047
Jeff King4a68e362017-07-13 11:01:18 -040048 if (!format->format) {
Karthik Nayakdf094742015-09-11 20:36:46 +053049 if (filter->lines) {
50 to_free = xstrfmt("%s %%(contents:lines=%d)",
Karthik Nayak17938f12017-01-10 14:19:46 +053051 "%(align:15)%(refname:lstrip=2)%(end)",
Karthik Nayakdf094742015-09-11 20:36:46 +053052 filter->lines);
Jeff King4a68e362017-07-13 11:01:18 -040053 format->format = to_free;
Karthik Nayakdf094742015-09-11 20:36:46 +053054 } else
Jeff King4a68e362017-07-13 11:01:18 -040055 format->format = "%(refname:lstrip=2)";
Carlos Rica62e09ce2007-07-20 01:42:28 +020056 }
57
Jeff King2eda0102017-07-13 10:56:10 -040058 if (verify_ref_format(format))
59 die(_("unable to parse format string"));
Karthik Nayak008ed7d2015-10-18 15:55:04 +053060 filter->with_commit_tag_algo = 1;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +053061 filter_refs(&array, filter, FILTER_REFS_TAGS);
62 ref_array_sort(sorting, &array);
Carlos Rica62e09ce2007-07-20 01:42:28 +020063
Karthik Nayakb7cc53e2015-09-11 20:36:16 +053064 for (i = 0; i < array.nr; i++)
Jeff King4a68e362017-07-13 11:01:18 -040065 show_ref_array_item(array.items[i], format);
Karthik Nayakb7cc53e2015-09-11 20:36:16 +053066 ref_array_clear(&array);
67 free(to_free);
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 19:56:52 +070068
Carlos Rica62e09ce2007-07-20 01:42:28 +020069 return 0;
70}
71
Carlos Ricae317cfa2007-07-21 14:13:12 +020072typedef int (*each_tag_name_fn)(const char *name, const char *ref,
brian m. carlson7422ab52017-05-06 22:10:08 +000073 const struct object_id *oid, const void *cb_data);
Carlos Rica62e09ce2007-07-20 01:42:28 +020074
Lukas Puehringer07d347c2017-01-17 18:37:21 -050075static int for_each_tag_name(const char **argv, each_tag_name_fn fn,
76 const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +020077{
78 const char **p;
Jeff King7f897b62017-03-28 15:46:30 -040079 struct strbuf ref = STRBUF_INIT;
Carlos Rica62e09ce2007-07-20 01:42:28 +020080 int had_error = 0;
brian m. carlson7422ab52017-05-06 22:10:08 +000081 struct object_id oid;
Carlos Rica62e09ce2007-07-20 01:42:28 +020082
83 for (p = argv; *p; p++) {
Jeff King7f897b62017-03-28 15:46:30 -040084 strbuf_reset(&ref);
85 strbuf_addf(&ref, "refs/tags/%s", *p);
brian m. carlson34c290a2017-10-15 22:06:56 +000086 if (read_ref(ref.buf, &oid)) {
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +000087 error(_("tag '%s' not found."), *p);
Carlos Rica62e09ce2007-07-20 01:42:28 +020088 had_error = 1;
89 continue;
90 }
brian m. carlson7422ab52017-05-06 22:10:08 +000091 if (fn(*p, ref.buf, &oid, cb_data))
Carlos Rica62e09ce2007-07-20 01:42:28 +020092 had_error = 1;
93 }
Jeff King7f897b62017-03-28 15:46:30 -040094 strbuf_release(&ref);
Carlos Rica62e09ce2007-07-20 01:42:28 +020095 return had_error;
96}
97
98static int delete_tag(const char *name, const char *ref,
brian m. carlson7422ab52017-05-06 22:10:08 +000099 const struct object_id *oid, const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200100{
brian m. carlson2616a5e2017-10-15 22:06:50 +0000101 if (delete_ref(NULL, ref, oid, 0))
Carlos Rica62e09ce2007-07-20 01:42:28 +0200102 return 1;
brian m. carlsonaab95832018-03-12 02:27:30 +0000103 printf(_("Deleted tag '%s' (was %s)\n"), name,
104 find_unique_abbrev(oid, DEFAULT_ABBREV));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200105 return 0;
106}
107
108static int verify_tag(const char *name, const char *ref,
brian m. carlson7422ab52017-05-06 22:10:08 +0000109 const struct object_id *oid, const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200110{
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500111 int flags;
Jeff King4a68e362017-07-13 11:01:18 -0400112 const struct ref_format *format = cb_data;
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500113 flags = GPG_VERIFY_VERBOSE;
114
Jeff King4a68e362017-07-13 11:01:18 -0400115 if (format->format)
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500116 flags = GPG_VERIFY_OMIT_STATUS;
117
Stefan Beller84571762017-07-12 17:44:15 -0700118 if (gpg_verify_tag(oid, name, flags))
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500119 return -1;
120
Jeff King4a68e362017-07-13 11:01:18 -0400121 if (format->format)
Jeff King53df97a2018-04-06 14:58:32 -0400122 pretty_print_ref(name, oid, format);
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500123
124 return 0;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200125}
126
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200127static int do_sign(struct strbuf *buffer)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200128{
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700129 return sign_buffer(buffer, buffer, get_signing_key());
Carlos Rica62e09ce2007-07-20 01:42:28 +0200130}
131
132static const char tag_template[] =
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200133 N_("\nWrite a message for tag:\n %s\n"
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100134 "Lines starting with '%c' will be ignored.\n");
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200135
136static const char tag_template_nocleanup[] =
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200137 N_("\nWrite a message for tag:\n %s\n"
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100138 "Lines starting with '%c' will be kept; you may remove them"
139 " yourself if you want to.\n");
Carlos Rica62e09ce2007-07-20 01:42:28 +0200140
Johannes Schindelinef90d6d2008-05-14 18:46:53 +0100141static int git_tag_config(const char *var, const char *value, void *cb)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200142{
Jacob Kellerb1507942014-07-16 14:48:02 -0700143 int status;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530144 struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
Jacob Kellerb1507942014-07-16 14:48:02 -0700145
146 if (!strcmp(var, "tag.sort")) {
147 if (!value)
148 return config_error_nonbool(var);
Jeff King18a25652017-07-13 11:02:44 -0400149 parse_ref_sorting(sorting_tail, value);
Jacob Kellerb1507942014-07-16 14:48:02 -0700150 return 0;
151 }
152
153 status = git_gpg_config(var, value, cb);
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700154 if (status)
155 return status;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100156 if (!strcmp(var, "tag.forcesignannotated")) {
157 force_sign_annotate = git_config_bool(var, value);
158 return 0;
159 }
160
Christian Couder59556542013-11-30 21:55:40 +0100161 if (starts_with(var, "column."))
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700162 return git_column_config(var, value, "tag", &colopts);
Jeff Kingb521fd12017-10-13 13:26:02 -0400163 return git_color_default_config(var, value, cb);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200164}
165
brian m. carlson7422ab52017-05-06 22:10:08 +0000166static void write_tag_body(int fd, const struct object_id *oid)
Mike Hommeybab81182007-11-04 01:11:14 +0100167{
168 unsigned long size;
169 enum object_type type;
Michael J Grubere10dfb62010-11-10 12:17:28 +0100170 char *buf, *sp;
Mike Hommeybab81182007-11-04 01:11:14 +0100171
brian m. carlsonb4f5aca2018-03-12 02:27:53 +0000172 buf = read_object_file(oid, &type, &size);
Mike Hommeybab81182007-11-04 01:11:14 +0100173 if (!buf)
174 return;
175 /* skip header */
176 sp = strstr(buf, "\n\n");
177
178 if (!sp || !size || type != OBJ_TAG) {
179 free(buf);
180 return;
181 }
182 sp += 2; /* skip the 2 LFs */
Michael J Grubere10dfb62010-11-10 12:17:28 +0100183 write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
Mike Hommeybab81182007-11-04 01:11:14 +0100184
185 free(buf);
186}
187
brian m. carlson7422ab52017-05-06 22:10:08 +0000188static int build_tag_object(struct strbuf *buf, int sign, struct object_id *result)
Jeff King3927bbe2008-12-06 14:40:34 -0500189{
190 if (sign && do_sign(buf) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000191 return error(_("unable to sign the tag"));
Patryk Obaraa09c9852018-01-28 01:13:19 +0100192 if (write_object_file(buf->buf, buf->len, tag_type, result) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000193 return error(_("unable to write tag file"));
Jeff King3927bbe2008-12-06 14:40:34 -0500194 return 0;
195}
196
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200197struct create_tag_options {
198 unsigned int message_given:1;
Nicolas Morey-Chaisemartin9eed6e42018-02-06 09:36:24 +0100199 unsigned int use_editor:1;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200200 unsigned int sign;
201 enum {
202 CLEANUP_NONE,
203 CLEANUP_SPACE,
204 CLEANUP_ALL
205 } cleanup_mode;
206};
207
brian m. carlson7422ab52017-05-06 22:10:08 +0000208static void create_tag(const struct object_id *object, const char *tag,
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200209 struct strbuf *buf, struct create_tag_options *opt,
brian m. carlson7422ab52017-05-06 22:10:08 +0000210 struct object_id *prev, struct object_id *result)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200211{
212 enum object_type type;
Jeff Kingb0ceab92017-03-28 15:46:23 -0400213 struct strbuf header = STRBUF_INIT;
Jeff King3927bbe2008-12-06 14:40:34 -0500214 char *path = NULL;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200215
Stefan Beller0df8e962018-04-25 11:20:59 -0700216 type = oid_object_info(the_repository, object, NULL);
Carlos Ricae317cfa2007-07-21 14:13:12 +0200217 if (type <= OBJ_NONE)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000218 die(_("bad object type."));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200219
Jeff Kingb0ceab92017-03-28 15:46:23 -0400220 strbuf_addf(&header,
221 "object %s\n"
222 "type %s\n"
223 "tag %s\n"
224 "tagger %s\n\n",
brian m. carlson7422ab52017-05-06 22:10:08 +0000225 oid_to_hex(object),
Brandon Williamsdebca9d2018-02-14 10:59:24 -0800226 type_name(type),
Jeff Kingb0ceab92017-03-28 15:46:23 -0400227 tag,
228 git_committer_info(IDENT_STRICT));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200229
Nicolas Morey-Chaisemartin9eed6e42018-02-06 09:36:24 +0100230 if (!opt->message_given || opt->use_editor) {
Carlos Rica62e09ce2007-07-20 01:42:28 +0200231 int fd;
232
233 /* write the template message before editing: */
Alex Riesena4f34cb2008-10-27 11:22:09 +0100234 path = git_pathdup("TAG_EDITMSG");
Carlos Rica62e09ce2007-07-20 01:42:28 +0200235 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
236 if (fd < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000237 die_errno(_("could not create file '%s'"), path);
Mike Hommeybab81182007-11-04 01:11:14 +0100238
Nicolas Morey-Chaisemartin9eed6e42018-02-06 09:36:24 +0100239 if (opt->message_given) {
240 write_or_die(fd, buf->buf, buf->len);
241 strbuf_reset(buf);
242 } else if (!is_null_oid(prev)) {
Mike Hommeybab81182007-11-04 01:11:14 +0100243 write_tag_body(fd, prev);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100244 } else {
245 struct strbuf buf = STRBUF_INIT;
246 strbuf_addch(&buf, '\n');
247 if (opt->cleanup_mode == CLEANUP_ALL)
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200248 strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100249 else
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200250 strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100251 write_or_die(fd, buf.buf, buf.len);
252 strbuf_release(&buf);
253 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200254 close(fd);
255
Stephan Beyer71982032008-07-25 18:28:42 +0200256 if (launch_editor(path, buf, NULL)) {
257 fprintf(stderr,
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000258 _("Please supply the message using either -m or -F option.\n"));
Stephan Beyer71982032008-07-25 18:28:42 +0200259 exit(1);
260 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200261 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200262
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200263 if (opt->cleanup_mode != CLEANUP_NONE)
Tobias Klauser63af4a82015-10-16 17:16:42 +0200264 strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200265
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200266 if (!opt->message_given && !buf->len)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000267 die(_("no tag message?"));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200268
Jeff Kingb0ceab92017-03-28 15:46:23 -0400269 strbuf_insert(buf, 0, header.buf, header.len);
270 strbuf_release(&header);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200271
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200272 if (build_tag_object(buf, opt->sign, result) < 0) {
Jeff King3927bbe2008-12-06 14:40:34 -0500273 if (path)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000274 fprintf(stderr, _("The tag message has been left in %s\n"),
Jeff King3927bbe2008-12-06 14:40:34 -0500275 path);
276 exit(128);
277 }
278 if (path) {
Alex Riesen691f1a22009-04-29 23:22:56 +0200279 unlink_or_warn(path);
Jeff King3927bbe2008-12-06 14:40:34 -0500280 free(path);
281 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200282}
283
brian m. carlson7422ab52017-05-06 22:10:08 +0000284static void create_reflog_msg(const struct object_id *oid, struct strbuf *sb)
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100285{
286 enum object_type type;
287 struct commit *c;
288 char *buf;
289 unsigned long size;
290 int subject_len = 0;
291 const char *subject_start;
292
293 char *rla = getenv("GIT_REFLOG_ACTION");
294 if (rla) {
295 strbuf_addstr(sb, rla);
296 } else {
Jean-Noel Avilac3027be2017-04-30 23:32:47 +0200297 strbuf_addstr(sb, "tag: tagging ");
brian m. carlson30e677e2018-03-12 02:27:28 +0000298 strbuf_add_unique_abbrev(sb, oid, DEFAULT_ABBREV);
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100299 }
300
301 strbuf_addstr(sb, " (");
Stefan Beller0df8e962018-04-25 11:20:59 -0700302 type = oid_object_info(the_repository, oid, NULL);
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100303 switch (type) {
304 default:
Jean-Noel Avilac3027be2017-04-30 23:32:47 +0200305 strbuf_addstr(sb, "object of unknown type");
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100306 break;
307 case OBJ_COMMIT:
brian m. carlsonb4f5aca2018-03-12 02:27:53 +0000308 if ((buf = read_object_file(oid, &type, &size)) != NULL) {
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100309 subject_len = find_commit_subject(buf, &subject_start);
310 strbuf_insert(sb, sb->len, subject_start, subject_len);
311 } else {
Jean-Noel Avilac3027be2017-04-30 23:32:47 +0200312 strbuf_addstr(sb, "commit object");
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100313 }
314 free(buf);
315
brian m. carlsonbc832662017-05-06 22:10:10 +0000316 if ((c = lookup_commit_reference(oid)) != NULL)
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100317 strbuf_addf(sb, ", %s", show_date(c->date, 0, DATE_MODE(SHORT)));
318 break;
319 case OBJ_TREE:
Jean-Noel Avilac3027be2017-04-30 23:32:47 +0200320 strbuf_addstr(sb, "tree object");
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100321 break;
322 case OBJ_BLOB:
Jean-Noel Avilac3027be2017-04-30 23:32:47 +0200323 strbuf_addstr(sb, "blob object");
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100324 break;
325 case OBJ_TAG:
Jean-Noel Avilac3027be2017-04-30 23:32:47 +0200326 strbuf_addstr(sb, "other tag object");
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100327 break;
328 }
329 strbuf_addch(sb, ')');
330}
331
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800332struct msg_arg {
333 int given;
334 struct strbuf buf;
335};
336
337static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
338{
339 struct msg_arg *msg = opt->value;
340
341 if (!arg)
342 return -1;
343 if (msg->buf.len)
344 strbuf_addstr(&(msg->buf), "\n\n");
345 strbuf_addstr(&(msg->buf), arg);
346 msg->given = 1;
347 return 0;
348}
349
Michael Schubert4f0accd2011-05-10 01:36:36 +0200350static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
351{
352 if (name[0] == '-')
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200353 return -1;
Michael Schubert4f0accd2011-05-10 01:36:36 +0200354
355 strbuf_reset(sb);
356 strbuf_addf(sb, "refs/tags/%s", name);
357
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200358 return check_refname_format(sb->buf, 0);
Michael Schubert4f0accd2011-05-10 01:36:36 +0200359}
360
Carlos Rica62e09ce2007-07-20 01:42:28 +0200361int cmd_tag(int argc, const char **argv, const char *prefix)
362{
Brandon Caseyf285a2d2008-10-09 14:12:12 -0500363 struct strbuf buf = STRBUF_INIT;
Michael Schubert4f0accd2011-05-10 01:36:36 +0200364 struct strbuf ref = STRBUF_INIT;
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100365 struct strbuf reflog_msg = STRBUF_INIT;
brian m. carlson7422ab52017-05-06 22:10:08 +0000366 struct object_id object, prev;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200367 const char *object_ref, *tag;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200368 struct create_tag_options opt;
369 char *cleanup_arg = NULL;
David Turner144c76f2015-07-21 17:04:55 -0400370 int create_reflog = 0;
Karthik Nayakac4cc862015-09-10 21:18:27 +0530371 int annotate = 0, force = 0;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100372 int cmdmode = 0, create_tag_object = 0;
Junio C Hamanodbd0f5c2008-08-06 11:43:47 -0700373 const char *msgfile = NULL, *keyid = NULL;
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800374 struct msg_arg msg = { 0, STRBUF_INIT };
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700375 struct ref_transaction *transaction;
376 struct strbuf err = STRBUF_INIT;
Karthik Nayakac4cc862015-09-10 21:18:27 +0530377 struct ref_filter filter;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530378 static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
Jeff King4a68e362017-07-13 11:01:18 -0400379 struct ref_format format = REF_FORMAT_INIT;
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700380 int icase = 0;
Nicolas Morey-Chaisemartin9eed6e42018-02-06 09:36:24 +0100381 int edit_flag = 0;
Carlos Rica39686582007-11-09 14:42:56 +0100382 struct option options[] = {
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700383 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530384 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700385 N_("print <n> lines of each tag message"),
Carlos Rica39686582007-11-09 14:42:56 +0100386 PARSE_OPT_OPTARG, NULL, 1 },
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700387 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
388 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
Carlos Rica39686582007-11-09 14:42:56 +0100389
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700390 OPT_GROUP(N_("Tag creation options")),
Stefan Bellerd5d09d42013-08-03 13:51:19 +0200391 OPT_BOOL('a', "annotate", &annotate,
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700392 N_("annotated tag, needs a message")),
393 OPT_CALLBACK('m', "message", &msg, N_("message"),
394 N_("tag message"), parse_msg_arg),
395 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
Nicolas Morey-Chaisemartin9eed6e42018-02-06 09:36:24 +0100396 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of tag message")),
Stefan Bellerd5d09d42013-08-03 13:51:19 +0200397 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700398 OPT_STRING(0, "cleanup", &cleanup_arg, N_("mode"),
399 N_("how to strip spaces and #comments from message")),
Junio C Hamanoe703d712014-03-23 15:58:12 -0700400 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700401 N_("use another key to sign the tag")),
Nguyễn Thái Ngọc Duy12247812018-02-09 18:01:42 +0700402 OPT__FORCE(&force, N_("replace the tag if exists"), 0),
Ralf Thielow98c32bd2015-09-11 18:04:13 +0200403 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
Jeff Kingdd059c62015-03-12 14:15:09 -0400404
405 OPT_GROUP(N_("Tag listing options")),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700406 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530407 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000408 OPT_NO_CONTAINS(&filter.no_commit, N_("print only tags that don't contain the commit")),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530409 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000410 OPT_WITHOUT(&filter.no_commit, N_("print only tags that don't contain the commit")),
Karthik Nayak52428602015-09-10 21:52:49 +0530411 OPT_MERGED(&filter, N_("print only tags that are merged")),
412 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530413 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
414 N_("field name to sort on"), &parse_opt_ref_sorting),
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 19:56:52 +0700415 {
Karthik Nayakac4cc862015-09-10 21:18:27 +0530416 OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
Ævar Arnfjörð Bjarmason1e0c3b62017-03-24 18:40:56 +0000417 N_("print only tags of the object"), PARSE_OPT_LASTARG_DEFAULT,
418 parse_opt_object_name, (intptr_t) "HEAD"
Tom Grennanae7706b2012-02-08 15:03:43 -0800419 },
Jeff King4a68e362017-07-13 11:01:18 -0400420 OPT_STRING( 0 , "format", &format.format, N_("format"),
421 N_("format to use for the output")),
Jeff King0c88bf52017-10-03 09:45:47 -0400422 OPT__COLOR(&format.use_color, N_("respect format colors")),
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700423 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
Carlos Rica39686582007-11-09 14:42:56 +0100424 OPT_END()
425 };
426
Karthik Nayak56b43602017-01-10 14:19:51 +0530427 setup_ref_filter_porcelain_msg();
428
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530429 git_config(git_tag_config, sorting_tail);
Carlos Rica39686582007-11-09 14:42:56 +0100430
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200431 memset(&opt, 0, sizeof(opt));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530432 memset(&filter, 0, sizeof(filter));
433 filter.lines = -1;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200434
Stephen Boyd37782922009-05-23 11:53:12 -0700435 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
Carlos Rica39686582007-11-09 14:42:56 +0100436
Linus Torvaldsbe15f502007-12-10 20:08:06 -0800437 if (keyid) {
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200438 opt.sign = 1;
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700439 set_signing_key(keyid);
Linus Torvaldsbe15f502007-12-10 20:08:06 -0800440 }
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100441 create_tag_object = (opt.sign || annotate || msg.given || msgfile);
442
Ævar Arnfjörð Bjarmason6a338142017-03-24 18:40:55 +0000443 if (!cmdmode) {
444 if (argc == 0)
445 cmdmode = 'l';
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000446 else if (filter.with_commit || filter.no_commit ||
Ævar Arnfjörð Bjarmason6a338142017-03-24 18:40:55 +0000447 filter.points_at.nr || filter.merge_commit ||
448 filter.lines != -1)
449 cmdmode = 'l';
450 }
Junio C Hamanoc1a41b92007-11-25 15:21:42 -0800451
Martin Ågrende121ff2017-08-02 21:40:53 +0200452 if (cmdmode == 'l')
Martin Ågrenff1e7242017-08-02 21:40:54 +0200453 setup_auto_pager("tag", 1);
Martin Ågrende121ff2017-08-02 21:40:53 +0200454
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100455 if ((create_tag_object || force) && (cmdmode != 0))
Samuel Tardieu6fa83422008-11-05 00:20:31 +0100456 usage_with_options(git_tag_usage, options);
457
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700458 finalize_colopts(&colopts, -1);
Karthik Nayakac4cc862015-09-10 21:18:27 +0530459 if (cmdmode == 'l' && filter.lines != -1) {
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700460 if (explicitly_enable_column(colopts))
461 die(_("--column and -n are incompatible"));
462 colopts = 0;
463 }
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530464 if (!sorting)
465 sorting = ref_default_sorting();
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700466 sorting->ignore_case = icase;
467 filter.ignore_case = icase;
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700468 if (cmdmode == 'l') {
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700469 int ret;
470 if (column_active(colopts)) {
471 struct column_options copts;
472 memset(&copts, 0, sizeof(copts));
473 copts.padding = 2;
474 run_column_filter(colopts, &copts);
475 }
Karthik Nayakac4cc862015-09-10 21:18:27 +0530476 filter.name_patterns = argv;
Jeff King4a68e362017-07-13 11:01:18 -0400477 ret = list_tags(&filter, sorting, &format);
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700478 if (column_active(colopts))
479 stop_column_filter();
480 return ret;
481 }
Karthik Nayakac4cc862015-09-10 21:18:27 +0530482 if (filter.lines != -1)
Ævar Arnfjörð Bjarmason6a338142017-03-24 18:40:55 +0000483 die(_("-n option is only allowed in list mode"));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530484 if (filter.with_commit)
Ævar Arnfjörð Bjarmason6a338142017-03-24 18:40:55 +0000485 die(_("--contains option is only allowed in list mode"));
Ævar Arnfjörð Bjarmasonac3f5a32017-03-24 18:40:57 +0000486 if (filter.no_commit)
487 die(_("--no-contains option is only allowed in list mode"));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530488 if (filter.points_at.nr)
Ævar Arnfjörð Bjarmason6a338142017-03-24 18:40:55 +0000489 die(_("--points-at option is only allowed in list mode"));
Karthik Nayak52428602015-09-10 21:52:49 +0530490 if (filter.merge_commit)
Ævar Arnfjörð Bjarmason6a338142017-03-24 18:40:55 +0000491 die(_("--merged and --no-merged options are only allowed in list mode"));
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700492 if (cmdmode == 'd')
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500493 return for_each_tag_name(argv, delete_tag, NULL);
494 if (cmdmode == 'v') {
Jeff King4a68e362017-07-13 11:01:18 -0400495 if (format.format && verify_ref_format(&format))
Jeff King2eda0102017-07-13 10:56:10 -0400496 usage_with_options(git_tag_usage, options);
Jeff King4a68e362017-07-13 11:01:18 -0400497 return for_each_tag_name(argv, verify_tag, &format);
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500498 }
Carlos Rica39686582007-11-09 14:42:56 +0100499
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800500 if (msg.given || msgfile) {
501 if (msg.given && msgfile)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000502 die(_("only one -F or -m option is allowed."));
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800503 if (msg.given)
504 strbuf_addbuf(&buf, &(msg.buf));
Carlos Rica39686582007-11-09 14:42:56 +0100505 else {
506 if (!strcmp(msgfile, "-")) {
Pierre Habouzit387e7e12007-09-27 15:25:55 +0200507 if (strbuf_read(&buf, 0, 1024) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000508 die_errno(_("cannot read '%s'"), msgfile);
Pierre Habouzit387e7e12007-09-27 15:25:55 +0200509 } else {
Carlos Rica39686582007-11-09 14:42:56 +0100510 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000511 die_errno(_("could not open or read '%s'"),
Thomas Rastd824cbb2009-06-27 17:58:46 +0200512 msgfile);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200513 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200514 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200515 }
516
Carlos Rica39686582007-11-09 14:42:56 +0100517 tag = argv[0];
Carlos Rica62e09ce2007-07-20 01:42:28 +0200518
Carlos Rica39686582007-11-09 14:42:56 +0100519 object_ref = argc == 2 ? argv[1] : "HEAD";
520 if (argc > 2)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000521 die(_("too many params"));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200522
brian m. carlson7422ab52017-05-06 22:10:08 +0000523 if (get_oid(object_ref, &object))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000524 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200525
Michael Schubert4f0accd2011-05-10 01:36:36 +0200526 if (strbuf_check_tag_ref(&ref, tag))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000527 die(_("'%s' is not a valid tag name."), tag);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200528
brian m. carlson34c290a2017-10-15 22:06:56 +0000529 if (read_ref(ref.buf, &prev))
brian m. carlson7422ab52017-05-06 22:10:08 +0000530 oidclr(&prev);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200531 else if (!force)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000532 die(_("tag '%s' already exists"), tag);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200533
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200534 opt.message_given = msg.given || msgfile;
Nicolas Morey-Chaisemartin9eed6e42018-02-06 09:36:24 +0100535 opt.use_editor = edit_flag;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200536
537 if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
538 opt.cleanup_mode = CLEANUP_ALL;
539 else if (!strcmp(cleanup_arg, "verbatim"))
540 opt.cleanup_mode = CLEANUP_NONE;
541 else if (!strcmp(cleanup_arg, "whitespace"))
542 opt.cleanup_mode = CLEANUP_SPACE;
543 else
544 die(_("Invalid cleanup mode %s"), cleanup_arg);
545
brian m. carlson7422ab52017-05-06 22:10:08 +0000546 create_reflog_msg(&object, &reflog_msg);
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100547
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100548 if (create_tag_object) {
549 if (force_sign_annotate && !annotate)
550 opt.sign = 1;
brian m. carlson7422ab52017-05-06 22:10:08 +0000551 create_tag(&object, tag, &buf, &opt, &prev, &object);
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100552 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200553
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700554 transaction = ref_transaction_begin(&err);
555 if (!transaction ||
brian m. carlson89f3bbd2017-10-15 22:06:53 +0000556 ref_transaction_update(transaction, ref.buf, &object, &prev,
David Turner144c76f2015-07-21 17:04:55 -0400557 create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
Cornelius Weigdf8512e2017-02-08 23:41:18 +0100558 reflog_msg.buf, &err) ||
Ronnie Sahlbergdb7516a2014-04-30 12:22:42 -0700559 ref_transaction_commit(transaction, &err))
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700560 die("%s", err.buf);
561 ref_transaction_free(transaction);
brian m. carlson7422ab52017-05-06 22:10:08 +0000562 if (force && !is_null_oid(&prev) && oidcmp(&prev, &object))
brian m. carlsonaab95832018-03-12 02:27:30 +0000563 printf(_("Updated tag '%s' (was %s)\n"), tag,
564 find_unique_abbrev(&prev, DEFAULT_ABBREV));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200565
Martin Ågren886e1082017-10-01 19:42:08 +0200566 UNLEAK(buf);
567 UNLEAK(ref);
568 UNLEAK(reflog_msg);
569 UNLEAK(msg);
570 UNLEAK(err);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200571 return 0;
572}