3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
10 .TH "GIT\-TAG" "1" "2025-01-10" "Git 2\&.48\&.0" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 git-tag \- Create, list, delete or verify a tag object signed with GPG
35 \fIgit tag\fR [\-a | \-s | \-u <key\-id>] [\-f] [\-m <msg> | \-F <file>] [\-e]
36 [(\-\-trailer <token>[(=|:)<value>])\&...\:]
37 <tagname> [<commit> | <object>]
38 \fIgit tag\fR \-d <tagname>\&...\:
39 \fIgit tag\fR [\-n[<num>]] \-l [\-\-contains <commit>] [\-\-no\-contains <commit>]
40 [\-\-points\-at <object>] [\-\-column[=<options>] | \-\-no\-column]
41 [\-\-create\-reflog] [\-\-sort=<key>] [\-\-format=<format>]
42 [\-\-merged <commit>] [\-\-no\-merged <commit>] [<pattern>\&...\:]
43 \fIgit tag\fR \-v [\-\-format=<format>] <tagname>\&...\:
47 Add a tag reference in \fBrefs/tags/\fR, unless \fB\-d/\-l/\-v\fR is given to delete, list or verify tags\&.
49 Unless \fB\-f\fR is given, the named tag must not yet exist\&.
51 If one of \fB\-a\fR, \fB\-s\fR, or \fB\-u\fR \fI<key\-id>\fR is passed, the command creates a \fItag\fR object, and requires a tag message\&. Unless \fB\-m\fR \fI<msg>\fR or \fB\-F\fR \fI<file>\fR is given, an editor is started for the user to type in the tag message\&.
53 If \fB\-m\fR \fI<msg>\fR or \fB\-F\fR \fI<file>\fR or \fB\-\-trailer\fR \fI<token>\fR[\fB=\fR\fI<value>\fR] is given and \fB\-a\fR, \fB\-s\fR, and \fB\-u\fR \fI<key\-id>\fR are absent, \fB\-a\fR is implied\&.
55 Otherwise, a tag reference that points directly at the given object (i\&.e\&., a lightweight tag) is created\&.
57 A GnuPG signed tag object will be created when \fB\-s\fR or \fB\-u\fR \fI<key\-id>\fR is used\&. When \fB\-u\fR \fI<key\-id>\fR is not used, the committer identity for the current user is used to find the GnuPG key for signing\&. The configuration variable \fBgpg\&.program\fR is used to specify custom GnuPG binary\&.
59 Tag objects (created with \fB\-a\fR, \fB\-s\fR, or \fB\-u\fR) are called "annotated" tags; they contain a creation date, the tagger name and e\-mail, a tagging message, and an optional GnuPG signature\&. Whereas a "lightweight" tag is simply a name for an object (usually a commit object)\&.
61 Annotated tags are meant for release while lightweight tags are meant for private or temporary object labels\&. For this reason, some git commands for naming objects (like \fBgit\fR \fBdescribe\fR) will ignore lightweight tags by default\&.
66 Make an unsigned, annotated tag object
71 Make a GPG\-signed tag, using the default e\-mail address\(cqs key\&. The default behavior of tag GPG\-signing is controlled by
73 configuration variable if it exists, or disabled otherwise\&. See
74 \fBgit-config\fR(1)\&.
81 configuration variable that is set to force each and every tag to be signed\&.
84 \-u <key\-id>, \-\-local\-user=<key\-id>
86 Make a GPG\-signed tag, using the given key\&.
91 Replace an existing tag with the given name (instead of failing)
96 Delete existing tags with the given names\&.
101 Verify the GPG signature of the given tag names\&.
106 <num> specifies how many lines from the annotation, if any, are printed when using \-l\&. Implies
109 The default is not to print any annotation lines\&. If no number is given to
110 \fB\-n\fR, only the first line is printed\&. If the tag is not annotated, the commit message is displayed instead\&.
115 List tags\&. With optional
116 \fI<pattern>\fR\&.\&.\&., e\&.g\&.
120 \*(Aqv\-*\*(Aq, list only the tags that match the pattern(s)\&.
122 Running "git tag" without arguments also lists all tags\&. The pattern is a shell wildcard (i\&.e\&., matched using fnmatch(3))\&. Multiple patterns may be given; if any of them matches, the tag is shown\&.
124 This option is implicitly supplied if any other list\-like option such as
126 is provided\&. See the documentation for each of those options for details\&.
131 Sort based on the key given\&. Prefix
133 to sort in descending order of the value\&. You may use the \-\-sort=<key> option multiple times, in which case the last key becomes the primary key\&. Also supports "version:refname" or "v:refname" (tag names are treated as versions)\&. The "version:refname" sort order can also be affected by the "versionsort\&.suffix" configuration variable\&. The keys supported are the same as those in
135 \fBfor\-each\-ref\fR\&. Sort order defaults to the value configured for the
137 variable if it exists, or lexicographic order otherwise\&. See
138 \fBgit-config\fR(1)\&.
143 Respect any colors specified in the
153 is absent, behave as if
158 \-i, \-\-ignore\-case
160 Sorting and filtering tags are case insensitive\&.
165 Do not print a newline after formatted refs where the format expands to the empty string\&.
168 \-\-column[=<options>], \-\-no\-column
170 Display tag listing in columns\&. See configuration variable
176 without options are equivalent to
182 This option is only applicable when listing tags without annotation lines\&.
185 \-\-contains [<commit>]
187 Only list tags which contain the specified commit (HEAD if not specified)\&. Implies
191 \-\-no\-contains [<commit>]
193 Only list tags which don\(cqt contain the specified commit (HEAD if not specified)\&. Implies
197 \-\-merged [<commit>]
199 Only list tags whose commits are reachable from the specified commit (\fBHEAD\fR
203 \-\-no\-merged [<commit>]
205 Only list tags whose commits are not reachable from the specified commit (\fBHEAD\fR
209 \-\-points\-at <object>
211 Only list tags of the given object (HEAD if not specified)\&. Implies
215 \-m <msg>, \-\-message=<msg>
217 Use the given tag message (instead of prompting)\&. If multiple
219 options are given, their values are concatenated as separate paragraphs\&. Implies
229 \-F <file>, \-\-file=<file>
231 Take the tag message from the given file\&. Use
233 to read the message from the standard input\&. Implies
243 \-\-trailer <token>[(=|:)<value>]
245 Specify a (<token>, <value>) pair that should be applied as a trailer\&. (e\&.g\&.
250 \fBvalue\fR" will add a "Custom\-Key" trailer to the tag message\&.) The
251 \fBtrailer\&.\fR* configuration variables (\fBgit-interpret-trailers\fR(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\&. The trailers can be extracted in
254 \fB\-\-list\fR, using
255 \fB\-\-format=\fR"%(\fBtrailers\fR)" placeholder\&.
260 The message taken from file with
262 and command line with
264 are usually used as the tag message unmodified\&. This option lets you further edit the message taken from these sources\&.
269 This option sets how the tag message is cleaned up\&. The
277 mode is default\&. The
279 mode does not change message at all,
281 removes just leading/trailing whitespace lines and
283 removes both whitespace and commentary\&.
288 Create a reflog for the tag\&. To globally enable reflogs for tags, see
289 \fBcore\&.logAllRefUpdates\fR
291 \fBgit-config\fR(1)\&. The negated form
292 \fB\-\-no\-create\-reflog\fR
293 only overrides an earlier
294 \fB\-\-create\-reflog\fR, but currently does not negate the setting of
295 \fBcore\&.logAllRefUpdates\fR\&.
300 A string that interpolates %(\fBfieldname\fR) from a tag ref being shown and the object it points at\&. The format is the same as that of
301 \fBgit-for-each-ref\fR(1)\&. When unspecified, defaults to %(\fBrefname:strip=2\fR)\&.
306 The name of the tag to create, delete, or describe\&. The new tag name must pass all checks defined by
307 \fBgit-check-ref-format\fR(1)\&. Some of these checks may restrict the characters allowed in a tag name\&.
312 The object that the new tag will refer to, usually a commit\&. Defaults to HEAD\&.
316 By default, \fIgit tag\fR in sign\-with\-default mode (\-s) will use your committer identity (of the form \fBYour\fR \fBName\fR <your@email\&.\fBaddress\fR>) to find a key\&. If you want to use a different default key, you can specify it in the repository configuration as follows:
323 signingKey = <gpg\-key\-id>
329 \fBpager\&.tag\fR is only respected when listing tags, i\&.e\&., when \fB\-l\fR is used or implied\&. The default is to use a pager\&. See \fBgit-config\fR(1)\&.
333 What should you do when you tag a wrong commit and you would want to re\-tag?
335 If you never pushed anything out, just re\-tag it\&. Use "\-f" to replace the old one\&. And you\(cqre done\&.
337 But if you have pushed things out (or others could just read your repository directly), then others will have already seen the old tag\&. In that case you can do one of two things:
347 The sane thing\&. Just admit you screwed up, and use a different name\&. Others have already seen one tag\-name, and if you keep the same name, you may be in the situation that two people both have "version X", but they actually have
349 "X"\*(Aqs\&. So just call it "X\&.1" and be done with it\&.
360 The insane thing\&. You really want to call the new version "X" too,
362 others have already seen the old one\&. So just use
364 again, as if you hadn\(cqt already published the old one\&.
367 However, Git does \fBnot\fR (and it should not) change tags behind users back\&. So if somebody already got the old tag, doing a \fIgit pull\fR on your tree shouldn\(cqt just make them overwrite the old one\&.
369 If somebody got a release tag from you, you cannot just change the tag for them by updating your own one\&. This is a big security issue, in that people MUST be able to trust their tag\-names\&. If you really want to do the insane thing, you need to just fess up to it, and tell people that you messed up\&. You can do that by making a very public announcement saying:
375 Ok, I messed up, and I pushed out an earlier version tagged as X\&. I
376 then fixed something, and retagged the *fixed* tree as X again\&.
378 If you got the wrong tag, and want the new one, please delete
379 the old one and fetch the new one by doing:
382 git fetch origin tag X
384 to get my updated tag\&.
386 You can test which tag you have by doing
390 which should return 0123456789abcdef\&.\&. if you have the new version\&.
392 Sorry for the inconvenience\&.
398 Does this seem a bit complicated? It \fBshould\fR be\&. There is no way that it would be correct to just "fix" it automatically\&. People need to know that their tags might have been changed\&.
399 .SS "On Automatic following"
401 If you are following somebody else\(cqs tree, you are most likely using remote\-tracking branches (eg\&. \fBrefs/remotes/origin/master\fR)\&. You usually want the tags from the other end\&.
403 On the other hand, if you are fetching because you would want a one\-shot merge from somebody else, you typically do not want to get tags from there\&. This happens more often for people near the toplevel but not limited to them\&. Mere mortals when pulling from each other do not necessarily want to automatically get private anchor point tags from the other person\&.
405 Often, "please pull" messages on the mailing list just provide two pieces of information: a repo URL and a branch name; this is designed to be easily cut&pasted at the end of a \fIgit fetch\fR command line:
411 Linus, please pull from
413 git://git\&.\&.\&.\&./proj\&.git master
415 to get the following updates\&.\&.\&.
427 $ git pull git://git\&.\&.\&.\&./proj\&.git master
433 In such a case, you do not want to automatically follow the other person\(cqs tags\&.
435 One important aspect of Git is its distributed nature, which largely means there is no inherent "upstream" or "downstream" in the system\&. On the face of it, the above example might seem to indicate that the tag namespace is owned by the upper echelon of people and that tags only flow downwards, but that is not the case\&. It only shows that the usage pattern determines who are interested in whose tags\&.
437 A one\-shot pull is a sign that a commit history is now crossing the boundary between one circle of people (e\&.g\&. "people who are primarily interested in the networking part of the kernel") who may have their own set of tags (e\&.g\&. "this is the third release candidate from the networking group to be proposed for general consumption with 2\&.6\&.21 release") to another circle of people (e\&.g\&. "people who integrate various subsystem improvements")\&. The latter are usually not interested in the detailed tags used internally in the former group (that is what "internal" means)\&. That is why it is desirable not to follow tags automatically in this case\&.
439 It may well be that among networking people, they may want to exchange the tags internal to their group, but in that workflow they are most likely tracking each other\(cqs progress by having remote\-tracking branches\&. Again, the heuristic to automatically follow such tags is a good thing\&.
440 .SS "On Backdating Tags"
442 If you have imported some changes from another VCS and would like to add tags for major releases of your work, it is useful to be able to specify the date to embed inside of the tag object; such data in the tag object affects, for example, the ordering of tags in the gitweb interface\&.
444 To set the date used in future tag objects, set the environment variable GIT_COMMITTER_DATE (see the later discussion of possible values; the most common form is "YYYY\-MM\-DD HH:MM")\&.
452 $ GIT_COMMITTER_DATE="2006\-10\-02 10:31" git tag \-s v1\&.0\&.1
459 The \fBGIT_AUTHOR_DATE\fR and \fBGIT_COMMITTER_DATE\fR environment variables support the following date formats:
464 \fI<unix\-timestamp>\fR
465 \fI<time\-zone\-offset>\fR, where
466 \fI<unix\-timestamp>\fR
467 is the number of seconds since the UNIX epoch\&.
468 \fI<time\-zone\-offset>\fR
469 is a positive or negative offset from UTC\&. For example CET (which is 1 hour ahead of UTC) is
475 The standard date format as described by RFC 2822, for example
486 Time and date specified by the ISO 8601 standard, for example
487 \fB2005\-04\-07T22:13:13\fR\&. The parser accepts a space instead of the
489 character as well\&. Fractional parts of a second will be ignored, for example
490 \fB2005\-04\-07T22:13:13\&.019\fR
492 \fB2005\-04\-07T22:13:13\fR\&.
498 .nr an-no-space-flag 1
505 In addition, the date part is accepted in the following formats:
506 \fBYYYY\&.MM\&.DD\fR,
509 \fBDD\&.MM\&.YYYY\fR\&.
515 \fB$GIT_DIR/TAG_EDITMSG\fR
517 This file contains the message of an in\-progress annotated tag\&. If
520 exits due to an error before creating an annotated tag then the tag message that has been provided by the user in an editor session will be available in this file, but may be overwritten by the next invocation of
526 When combining multiple \fB\-\-contains\fR and \fB\-\-no\-contains\fR filters, only references that contain at least one of the \fB\-\-contains\fR commits and contain none of the \fB\-\-no\-contains\fR commits are shown\&.
528 When combining multiple \fB\-\-merged\fR and \fB\-\-no\-merged\fR filters, only references that are reachable from at least one of the \fB\-\-merged\fR commits and from none of the \fB\-\-no\-merged\fR commits are shown\&.
531 \fBgit-check-ref-format\fR(1)\&. \fBgit-config\fR(1)\&.
534 Part of the \fBgit\fR(1) suite