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