Documentation/git-tag.txt

   1 git-tag(1)
   2 ==========
   3
   4 NAME
   5 ----
   6 git-tag - Create, list, delete or verify a tag object signed with GPG
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
  13         <tagname> [<commit> | <object>]
  14 'git tag' -d <tagname>...
  15 'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>...]
  16 'git tag' -v <tagname>...
  17
  18 DESCRIPTION
  19 -----------
  20
  21 Add a tag reference in `refs/tags/`, unless `-d/-l/-v` is given
  22 to delete, list or verify tags.
  23
  24 Unless `-f` is given, the named tag must not yet exist.
  25
  26 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
  27 creates a 'tag' object, and requires a tag message.  Unless
  28 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
  29 in the tag message.
  30
  31 If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
  32 are absent, `-a` is implied.
  33
  34 Otherwise just a tag reference for the SHA1 object name of the commit object is
  35 created (i.e. a lightweight tag).
  36
  37 A GnuPG signed tag object will be created when `-s` or `-u
  38 <key-id>` is used.  When `-u <key-id>` is not used, the
  39 committer identity for the current user is used to find the
  40 GnuPG key for signing.  The configuration variable `gpg.program`
  41 is used to specify custom GnuPG binary.
  42
  43
  44 OPTIONS
  45 -------
  46 -a::
  47 --annotate::
  48         Make an unsigned, annotated tag object
  49
  50 -s::
  51 --sign::
  52         Make a GPG-signed tag, using the default e-mail address's key.
  53
  54 -u <key-id>::
  55 --local-user=<key-id>::
  56         Make a GPG-signed tag, using the given key.
  57
  58 -f::
  59 --force::
  60         Replace an existing tag with the given name (instead of failing)
  61
  62 -d::
  63 --delete::
  64         Delete existing tags with the given names.
  65
  66 -v::
  67 --verify::
  68         Verify the gpg signature of the given tag names.
  69
  70 -n<num>::
  71         <num> specifies how many lines from the annotation, if any,
  72         are printed when using -l.
  73         The default is not to print any annotation lines.
  74         If no number is given to `-n`, only the first line is printed.
  75         If the tag is not annotated, the commit message is displayed instead.
  76
  77 -l <pattern>::
  78 --list <pattern>::
  79         List tags with names that match the given pattern (or all if no
  80         pattern is given).  Running "git tag" without arguments also
  81         lists all tags. The pattern is a shell wildcard (i.e., matched
  82         using fnmatch(3)).  Multiple patterns may be given; if any of
  83         them matches, the tag is shown.
  84
  85 --contains <commit>::
  86         Only list tags which contain the specified commit.
  87
  88 -m <msg>::
  89 --message=<msg>::
  90         Use the given tag message (instead of prompting).
  91         If multiple `-m` options are given, their values are
  92         concatenated as separate paragraphs.
  93         Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
  94         is given.
  95
  96 -F <file>::
  97 --file=<file>::
  98         Take the tag message from the given file.  Use '-' to
  99         read the message from the standard input.
 100         Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
 101         is given.
 102
 103 --cleanup=<mode>::
 104         This option sets how the tag message is cleaned up.
 105         The  '<mode>' can be one of 'verbatim', 'whitespace' and 'strip'.  The
 106         'strip' mode is default. The 'verbatim' mode does not change message at
 107         all, 'whitespace' removes just leading/trailing whitespace lines and
 108         'strip' removes both whitespace and commentary.
 109
 110 <tagname>::
 111         The name of the tag to create, delete, or describe.
 112         The new tag name must pass all checks defined by
 113         linkgit:git-check-ref-format[1].  Some of these checks
 114         may restrict the characters allowed in a tag name.
 115
 116 CONFIGURATION
 117 -------------
 118 By default, 'git tag' in sign-with-default mode (-s) will use your
 119 committer identity (of the form "Your Name <your@email.address>") to
 120 find a key.  If you want to use a different default key, you can specify
 121 it in the repository configuration as follows:
 122
 123 -------------------------------------
 124 [user]
 125     signingkey = <gpg-key-id>
 126 -------------------------------------
 127
 128
 129 DISCUSSION
 130 ----------
 131
 132 On Re-tagging
 133 ~~~~~~~~~~~~~
 134
 135 What should you do when you tag a wrong commit and you would
 136 want to re-tag?
 137
 138 If you never pushed anything out, just re-tag it. Use "-f" to
 139 replace the old one. And you're done.
 140
 141 But if you have pushed things out (or others could just read
 142 your repository directly), then others will have already seen
 143 the old tag. In that case you can do one of two things:
 144
 145 . The sane thing.
 146 Just admit you screwed up, and use a different name. Others have
 147 already seen one tag-name, and if you keep the same name, you
 148 may be in the situation that two people both have "version X",
 149 but they actually have 'different' "X"'s.  So just call it "X.1"
 150 and be done with it.
 151
 152 . The insane thing.
 153 You really want to call the new version "X" too, 'even though'
 154 others have already seen the old one. So just use 'git tag -f'
 155 again, as if you hadn't already published the old one.
 156
 157 However, Git does *not* (and it should not) change tags behind
 158 users back. So if somebody already got the old tag, doing a
 159 'git pull' on your tree shouldn't just make them overwrite the old
 160 one.
 161
 162 If somebody got a release tag from you, you cannot just change
 163 the tag for them by updating your own one. This is a big
 164 security issue, in that people MUST be able to trust their
 165 tag-names.  If you really want to do the insane thing, you need
 166 to just fess up to it, and tell people that you messed up. You
 167 can do that by making a very public announcement saying:
 168
 169 ------------
 170 Ok, I messed up, and I pushed out an earlier version tagged as X. I
 171 then fixed something, and retagged the *fixed* tree as X again.
 172
 173 If you got the wrong tag, and want the new one, please delete
 174 the old one and fetch the new one by doing:
 175
 176         git tag -d X
 177         git fetch origin tag X
 178
 179 to get my updated tag.
 180
 181 You can test which tag you have by doing
 182
 183         git rev-parse X
 184
 185 which should return 0123456789abcdef.. if you have the new version.
 186
 187 Sorry for the inconvenience.
 188 ------------
 189
 190 Does this seem a bit complicated?  It *should* be. There is no
 191 way that it would be correct to just "fix" it automatically.
 192 People need to know that their tags might have been changed.
 193
 194
 195 On Automatic following
 196 ~~~~~~~~~~~~~~~~~~~~~~
 197
 198 If you are following somebody else's tree, you are most likely
 199 using remote-tracking branches (`refs/heads/origin` in traditional
 200 layout, or `refs/remotes/origin/master` in the separate-remote
 201 layout).  You usually want the tags from the other end.
 202
 203 On the other hand, if you are fetching because you would want a
 204 one-shot merge from somebody else, you typically do not want to
 205 get tags from there.  This happens more often for people near
 206 the toplevel but not limited to them.  Mere mortals when pulling
 207 from each other do not necessarily want to automatically get
 208 private anchor point tags from the other person.
 209
 210 Often, "please pull" messages on the mailing list just provide
 211 two pieces of information: a repo URL and a branch name; this
 212 is designed to be easily cut&pasted at the end of a 'git fetch'
 213 command line:
 214
 215 ------------
 216 Linus, please pull from
 217
 218         git://git..../proj.git master
 219
 220 to get the following updates...
 221 ------------
 222
 223 becomes:
 224
 225 ------------
 226 $ git pull git://git..../proj.git master
 227 ------------
 228
 229 In such a case, you do not want to automatically follow the other
 230 person's tags.
 231
 232 One important aspect of git is its distributed nature, which
 233 largely means there is no inherent "upstream" or
 234 "downstream" in the system.  On the face of it, the above
 235 example might seem to indicate that the tag namespace is owned
 236 by the upper echelon of people and that tags only flow downwards, but
 237 that is not the case.  It only shows that the usage pattern
 238 determines who are interested in whose tags.
 239
 240 A one-shot pull is a sign that a commit history is now crossing
 241 the boundary between one circle of people (e.g. "people who are
 242 primarily interested in the networking part of the kernel") who may
 243 have their own set of tags (e.g. "this is the third release
 244 candidate from the networking group to be proposed for general
 245 consumption with 2.6.21 release") to another circle of people
 246 (e.g. "people who integrate various subsystem improvements").
 247 The latter are usually not interested in the detailed tags used
 248 internally in the former group (that is what "internal" means).
 249 That is why it is desirable not to follow tags automatically in
 250 this case.
 251
 252 It may well be that among networking people, they may want to
 253 exchange the tags internal to their group, but in that workflow
 254 they are most likely tracking each other's progress by
 255 having remote-tracking branches.  Again, the heuristic to automatically
 256 follow such tags is a good thing.
 257
 258
 259 On Backdating Tags
 260 ~~~~~~~~~~~~~~~~~~
 261
 262 If you have imported some changes from another VCS and would like
 263 to add tags for major releases of your work, it is useful to be able
 264 to specify the date to embed inside of the tag object; such data in
 265 the tag object affects, for example, the ordering of tags in the
 266 gitweb interface.
 267
 268 To set the date used in future tag objects, set the environment
 269 variable GIT_COMMITTER_DATE (see the later discussion of possible
 270 values; the most common form is "YYYY-MM-DD HH:MM").
 271
 272 For example:
 273
 274 ------------
 275 $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
 276 ------------
 277
 278 include::date-formats.txt[]
 279
 280 SEE ALSO
 281 --------
 282 linkgit:git-check-ref-format[1].
 283
 284 GIT
 285 ---
 286 Part of the linkgit:git[1] suite