]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-tag(1) |
2 | ========== | |
2cf565c5 DG |
3 | |
4 | NAME | |
5 | ---- | |
453c1e85 | 6 | git-tag - Create, list, delete or verify a tag object signed with GPG |
2cf565c5 DG |
7 | |
8 | ||
2cf565c5 DG |
9 | SYNOPSIS |
10 | -------- | |
b867c7c2 | 11 | [verse] |
340f2c5e | 12 | 'git tag' [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>] |
b85e6c5f NS |
13 | <tagname> [<commit> | <object>] |
14 | 'git tag' -d <tagname>... | |
ae7706b9 | 15 | 'git tag' [-n[<num>]] -l [--contains <commit>] [--points-at <object>] |
df094741 | 16 | [--column[=<options>] | --no-column] [--create-reflog] [--sort=<key>] |
5242860f | 17 | [--format=<format>] [--[no-]merged [<commit>]] [<pattern>...] |
07d347cf | 18 | 'git tag' -v [--format=<format>] <tagname>... |
2cf565c5 DG |
19 | |
20 | DESCRIPTION | |
21 | ----------- | |
18b07930 | 22 | |
831e61f8 | 23 | Add a tag reference in `refs/tags/`, unless `-d/-l/-v` is given |
cfb5e6b2 | 24 | to delete, list or verify tags. |
b7e438f9 | 25 | |
831e61f8 | 26 | Unless `-f` is given, the named tag must not yet exist. |
b7e438f9 | 27 | |
340f2c5e | 28 | If one of `-a`, `-s`, or `-u <keyid>` is passed, the command |
cfb5e6b2 | 29 | creates a 'tag' object, and requires a tag message. Unless |
62e09ce9 | 30 | `-m <msg>` or `-F <file>` is given, an editor is started for the user to type |
bc162e40 | 31 | in the tag message. |
b7e438f9 | 32 | |
340f2c5e | 33 | If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <keyid>` |
995e8df4 DS |
34 | are absent, `-a` is implied. |
35 | ||
d5fa1f1a | 36 | Otherwise just a tag reference for the SHA-1 object name of the commit object is |
cfb5e6b2 | 37 | created (i.e. a lightweight tag). |
bc162e40 LT |
38 | |
39 | A GnuPG signed tag object will be created when `-s` or `-u | |
340f2c5e | 40 | <keyid>` is used. When `-u <keyid>` is not used, the |
bc162e40 | 41 | committer identity for the current user is used to find the |
0c5e70f0 JH |
42 | GnuPG key for signing. The configuration variable `gpg.program` |
43 | is used to specify custom GnuPG binary. | |
44 | ||
eeff891a | 45 | Tag objects (created with `-a`, `-s`, or `-u`) are called "annotated" |
29d55538 DS |
46 | tags; they contain a creation date, the tagger name and e-mail, a |
47 | tagging message, and an optional GnuPG signature. Whereas a | |
48 | "lightweight" tag is simply a name for an object (usually a commit | |
49 | object). | |
50 | ||
51 | Annotated tags are meant for release while lightweight tags are meant | |
52 | for private or temporary object labels. For this reason, some git | |
53 | commands for naming objects (like `git describe`) will ignore | |
54 | lightweight tags by default. | |
55 | ||
2cf565c5 | 56 | |
d839091d NW |
57 | OPTIONS |
58 | ------- | |
59 | -a:: | |
c97eff5a | 60 | --annotate:: |
d839091d NW |
61 | Make an unsigned, annotated tag object |
62 | ||
63 | -s:: | |
c97eff5a | 64 | --sign:: |
0c5e70f0 | 65 | Make a GPG-signed tag, using the default e-mail address's key. |
d839091d | 66 | |
340f2c5e MM |
67 | -u <keyid>:: |
68 | --local-user=<keyid>:: | |
0c5e70f0 | 69 | Make a GPG-signed tag, using the given key. |
d839091d NW |
70 | |
71 | -f:: | |
f7aec129 | 72 | --force:: |
d839091d NW |
73 | Replace an existing tag with the given name (instead of failing) |
74 | ||
75 | -d:: | |
c97eff5a | 76 | --delete:: |
453c1e85 | 77 | Delete existing tags with the given names. |
d839091d | 78 | |
0bc72abd | 79 | -v:: |
c97eff5a | 80 | --verify:: |
bc913167 | 81 | Verify the GPG signature of the given tag names. |
0bc72abd | 82 | |
3f36cbba | 83 | -n<num>:: |
980ea5c5 MM |
84 | <num> specifies how many lines from the annotation, if any, |
85 | are printed when using -l. | |
86 | The default is not to print any annotation lines. | |
62e09ce9 | 87 | If no number is given to `-n`, only the first line is printed. |
abfd5fa8 | 88 | If the tag is not annotated, the commit message is displayed instead. |
980ea5c5 | 89 | |
b867c7c2 | 90 | -l <pattern>:: |
c97eff5a | 91 | --list <pattern>:: |
588d0e83 JK |
92 | List tags with names that match the given pattern (or all if no |
93 | pattern is given). Running "git tag" without arguments also | |
94 | lists all tags. The pattern is a shell wildcard (i.e., matched | |
95 | using fnmatch(3)). Multiple patterns may be given; if any of | |
96 | them matches, the tag is shown. | |
b867c7c2 | 97 | |
b7cc53e9 KN |
98 | --sort=<key>:: |
99 | Sort based on the key given. Prefix `-` to sort in | |
100 | descending order of the value. You may use the --sort=<key> option | |
101 | multiple times, in which case the last key becomes the primary | |
102 | key. Also supports "version:refname" or "v:refname" (tag | |
64f7a264 | 103 | names are treated as versions). The "version:refname" sort |
c026557a SG |
104 | order can also be affected by the "versionsort.suffix" |
105 | configuration variable. | |
b7cc53e9 | 106 | The keys supported are the same as those in `git for-each-ref`. |
ae9f6311 | 107 | Sort order defaults to the value configured for the `tag.sort` |
64f7a264 MH |
108 | variable if it exists, or lexicographic order otherwise. See |
109 | linkgit:git-config[1]. | |
9ef176b5 | 110 | |
3bb16a8b NTND |
111 | -i:: |
112 | --ignore-case:: | |
113 | Sorting and filtering tags are case insensitive. | |
114 | ||
d96e3c15 NTND |
115 | --column[=<options>]:: |
116 | --no-column:: | |
117 | Display tag listing in columns. See configuration variable | |
118 | column.tag for option syntax.`--column` and `--no-column` | |
119 | without options are equivalent to 'always' and 'never' respectively. | |
120 | + | |
121 | This option is only applicable when listing tags without annotation lines. | |
122 | ||
81966ab2 NTND |
123 | --contains [<commit>]:: |
124 | Only list tags which contain the specified commit (HEAD if not | |
125 | specified). | |
32c35cfb | 126 | |
b0840609 | 127 | --merged [<commit>]:: |
8881d35c ÆAB |
128 | Only list tags whose commits are reachable from the specified |
129 | commit (`HEAD` if not specified). | |
b0840609 ÆAB |
130 | |
131 | --no-merged [<commit>]:: | |
8881d35c | 132 | Only list tags whose commits are not reachable from the specified |
b0840609 | 133 | commit (`HEAD` if not specified). |
0488792d | 134 | |
ae7706b9 TG |
135 | --points-at <object>:: |
136 | Only list tags of the given object. | |
137 | ||
d839091d | 138 | -m <msg>:: |
c97eff5a | 139 | --message=<msg>:: |
bd46c9a9 | 140 | Use the given tag message (instead of prompting). |
d99bf51a | 141 | If multiple `-m` options are given, their values are |
bd46c9a9 | 142 | concatenated as separate paragraphs. |
340f2c5e | 143 | Implies `-a` if none of `-a`, `-s`, or `-u <keyid>` |
995e8df4 | 144 | is given. |
d839091d | 145 | |
f79c73ce | 146 | -F <file>:: |
c97eff5a | 147 | --file=<file>:: |
f79c73ce JS |
148 | Take the tag message from the given file. Use '-' to |
149 | read the message from the standard input. | |
340f2c5e | 150 | Implies `-a` if none of `-a`, `-s`, or `-u <keyid>` |
995e8df4 | 151 | is given. |
2cf565c5 | 152 | |
d3e05983 KS |
153 | --cleanup=<mode>:: |
154 | This option sets how the tag message is cleaned up. | |
155 | The '<mode>' can be one of 'verbatim', 'whitespace' and 'strip'. The | |
156 | 'strip' mode is default. The 'verbatim' mode does not change message at | |
157 | all, 'whitespace' removes just leading/trailing whitespace lines and | |
158 | 'strip' removes both whitespace and commentary. | |
159 | ||
144c76fa | 160 | --create-reflog:: |
341fb286 CW |
161 | Create a reflog for the tag. To globally enable reflogs for tags, see |
162 | `core.logAllRefUpdates` in linkgit:git-config[1]. | |
67c70bd9 CW |
163 | The negated form `--no-create-reflog` only overrides an earlier |
164 | `--create-reflog`, but currently does not negate the setting of | |
165 | `core.logallrefupdates`. | |
144c76fa | 166 | |
b85e6c5f NS |
167 | <tagname>:: |
168 | The name of the tag to create, delete, or describe. | |
169 | The new tag name must pass all checks defined by | |
170 | linkgit:git-check-ref-format[1]. Some of these checks | |
171 | may restrict the characters allowed in a tag name. | |
172 | ||
dd686cd4 TR |
173 | <commit>:: |
174 | <object>:: | |
175 | The object that the new tag will refer to, usually a commit. | |
176 | Defaults to HEAD. | |
177 | ||
df094741 KN |
178 | <format>:: |
179 | A string that interpolates `%(fieldname)` from the object | |
180 | pointed at by a ref being shown. The format is the same as | |
181 | that of linkgit:git-for-each-ref[1]. When unspecified, | |
0571979b | 182 | defaults to `%(refname:strip=2)`. |
dd686cd4 | 183 | |
d67778ec AP |
184 | CONFIGURATION |
185 | ------------- | |
0b444cdb | 186 | By default, 'git tag' in sign-with-default mode (-s) will use your |
d595bdc1 | 187 | committer identity (of the form `Your Name <your@email.address>`) to |
d67778ec AP |
188 | find a key. If you want to use a different default key, you can specify |
189 | it in the repository configuration as follows: | |
190 | ||
86b9e017 | 191 | ------------------------------------- |
d67778ec | 192 | [user] |
340f2c5e | 193 | signingKey = <gpg-keyid> |
86b9e017 | 194 | ------------------------------------- |
d67778ec | 195 | |
4853534e JH |
196 | |
197 | DISCUSSION | |
198 | ---------- | |
199 | ||
200 | On Re-tagging | |
201 | ~~~~~~~~~~~~~ | |
202 | ||
203 | What should you do when you tag a wrong commit and you would | |
204 | want to re-tag? | |
205 | ||
206 | If you never pushed anything out, just re-tag it. Use "-f" to | |
207 | replace the old one. And you're done. | |
208 | ||
209 | But if you have pushed things out (or others could just read | |
210 | your repository directly), then others will have already seen | |
211 | the old tag. In that case you can do one of two things: | |
212 | ||
213 | . The sane thing. | |
214 | Just admit you screwed up, and use a different name. Others have | |
215 | already seen one tag-name, and if you keep the same name, you | |
216 | may be in the situation that two people both have "version X", | |
217 | but they actually have 'different' "X"'s. So just call it "X.1" | |
218 | and be done with it. | |
219 | ||
220 | . The insane thing. | |
221 | You really want to call the new version "X" too, 'even though' | |
0b444cdb | 222 | others have already seen the old one. So just use 'git tag -f' |
4853534e JH |
223 | again, as if you hadn't already published the old one. |
224 | ||
06ada152 | 225 | However, Git does *not* (and it should not) change tags behind |
46e56e81 | 226 | users back. So if somebody already got the old tag, doing a |
0b444cdb | 227 | 'git pull' on your tree shouldn't just make them overwrite the old |
4853534e JH |
228 | one. |
229 | ||
230 | If somebody got a release tag from you, you cannot just change | |
231 | the tag for them by updating your own one. This is a big | |
232 | security issue, in that people MUST be able to trust their | |
233 | tag-names. If you really want to do the insane thing, you need | |
234 | to just fess up to it, and tell people that you messed up. You | |
235 | can do that by making a very public announcement saying: | |
236 | ||
237 | ------------ | |
238 | Ok, I messed up, and I pushed out an earlier version tagged as X. I | |
239 | then fixed something, and retagged the *fixed* tree as X again. | |
240 | ||
241 | If you got the wrong tag, and want the new one, please delete | |
242 | the old one and fetch the new one by doing: | |
243 | ||
244 | git tag -d X | |
245 | git fetch origin tag X | |
246 | ||
247 | to get my updated tag. | |
248 | ||
249 | You can test which tag you have by doing | |
250 | ||
251 | git rev-parse X | |
252 | ||
253 | which should return 0123456789abcdef.. if you have the new version. | |
254 | ||
f1723ee6 | 255 | Sorry for the inconvenience. |
4853534e JH |
256 | ------------ |
257 | ||
258 | Does this seem a bit complicated? It *should* be. There is no | |
f1723ee6 MW |
259 | way that it would be correct to just "fix" it automatically. |
260 | People need to know that their tags might have been changed. | |
4853534e JH |
261 | |
262 | ||
263 | On Automatic following | |
264 | ~~~~~~~~~~~~~~~~~~~~~~ | |
265 | ||
266 | If you are following somebody else's tree, you are most likely | |
749a2279 YK |
267 | using remote-tracking branches (eg. `refs/remotes/origin/master`). |
268 | You usually want the tags from the other end. | |
4853534e JH |
269 | |
270 | On the other hand, if you are fetching because you would want a | |
271 | one-shot merge from somebody else, you typically do not want to | |
272 | get tags from there. This happens more often for people near | |
273 | the toplevel but not limited to them. Mere mortals when pulling | |
274 | from each other do not necessarily want to automatically get | |
275 | private anchor point tags from the other person. | |
276 | ||
f1723ee6 MW |
277 | Often, "please pull" messages on the mailing list just provide |
278 | two pieces of information: a repo URL and a branch name; this | |
279 | is designed to be easily cut&pasted at the end of a 'git fetch' | |
280 | command line: | |
4853534e JH |
281 | |
282 | ------------ | |
283 | Linus, please pull from | |
284 | ||
285 | git://git..../proj.git master | |
286 | ||
287 | to get the following updates... | |
288 | ------------ | |
289 | ||
290 | becomes: | |
291 | ||
292 | ------------ | |
293 | $ git pull git://git..../proj.git master | |
294 | ------------ | |
295 | ||
f1723ee6 MW |
296 | In such a case, you do not want to automatically follow the other |
297 | person's tags. | |
4853534e | 298 | |
2de9b711 | 299 | One important aspect of Git is its distributed nature, which |
f1723ee6 | 300 | largely means there is no inherent "upstream" or |
4853534e JH |
301 | "downstream" in the system. On the face of it, the above |
302 | example might seem to indicate that the tag namespace is owned | |
f1723ee6 | 303 | by the upper echelon of people and that tags only flow downwards, but |
4853534e JH |
304 | that is not the case. It only shows that the usage pattern |
305 | determines who are interested in whose tags. | |
306 | ||
307 | A one-shot pull is a sign that a commit history is now crossing | |
308 | the boundary between one circle of people (e.g. "people who are | |
d99bf51a | 309 | primarily interested in the networking part of the kernel") who may |
4853534e JH |
310 | have their own set of tags (e.g. "this is the third release |
311 | candidate from the networking group to be proposed for general | |
312 | consumption with 2.6.21 release") to another circle of people | |
313 | (e.g. "people who integrate various subsystem improvements"). | |
314 | The latter are usually not interested in the detailed tags used | |
315 | internally in the former group (that is what "internal" means). | |
316 | That is why it is desirable not to follow tags automatically in | |
317 | this case. | |
318 | ||
319 | It may well be that among networking people, they may want to | |
320 | exchange the tags internal to their group, but in that workflow | |
f1723ee6 | 321 | they are most likely tracking each other's progress by |
8b3f3f84 | 322 | having remote-tracking branches. Again, the heuristic to automatically |
4853534e JH |
323 | follow such tags is a good thing. |
324 | ||
325 | ||
5040beff MO |
326 | On Backdating Tags |
327 | ~~~~~~~~~~~~~~~~~~ | |
328 | ||
329 | If you have imported some changes from another VCS and would like | |
330 | to add tags for major releases of your work, it is useful to be able | |
f1723ee6 | 331 | to specify the date to embed inside of the tag object; such data in |
5040beff MO |
332 | the tag object affects, for example, the ordering of tags in the |
333 | gitweb interface. | |
334 | ||
335 | To set the date used in future tag objects, set the environment | |
f1723ee6 MW |
336 | variable GIT_COMMITTER_DATE (see the later discussion of possible |
337 | values; the most common form is "YYYY-MM-DD HH:MM"). | |
5040beff | 338 | |
f1723ee6 | 339 | For example: |
5040beff MO |
340 | |
341 | ------------ | |
055b6615 | 342 | $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1 |
5040beff MO |
343 | ------------ |
344 | ||
f1723ee6 | 345 | include::date-formats.txt[] |
5040beff | 346 | |
b85e6c5f NS |
347 | SEE ALSO |
348 | -------- | |
349 | linkgit:git-check-ref-format[1]. | |
b150794d | 350 | linkgit:git-config[1]. |
b85e6c5f | 351 | |
2cf565c5 DG |
352 | GIT |
353 | --- | |
9e1f0a85 | 354 | Part of the linkgit:git[1] suite |