I want git to list all tags along with the full annotation or commit message. Something like this is close:
git tag -n5
This does exactly what I want except that it will only show up to the first 5 lines of the tag message.
I guess I can just use a very large number. What is the highest number I can use here? Is it the same on every computer?
UPDATE: I have had much time to think about this, and now I think I don't necessarily want to show the entirety of each message if some of them are extraordinarily long. I didn't really have any particular need that required me to see massive messages (other than my own propensity to be long winded in everything I write, including tag messages). I just didn't like the idea that it was not necessarily going to show me the whole message, as that made me feel like it was hiding information from me. But too much information can also be a bad thing.
git tag -n
did it for me
git tag -n
only prints the first line of the annotation, according to the manpage.
Try this it will list all the tags along with annotations & 9 lines of message for every tag:
git tag -n9
can also use
git tag -l -n9
if specific tags are to list:
git tag -l -n9 v3.*
(e.g, above command will only display tags starting with "v3.")
-l , --list List tags with names that match the given pattern (or all if no pattern is given). 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.
git tag -n99
Short and sweet. This will list up to 99 lines from each tag annotation/commit message. Here is a link to the official documentation for git tag.
I now think the limitation of only showing up to 99 lines per tag is actually a good thing as most of the time, if there were really more than 99 lines for a single tag, you wouldn't really want to see all the rest of the lines would you? If you did want to see more than 99 lines per tag, you could always increase this to a larger number.
I mean, I guess there could be a specific situation or reason to want to see massive tag messages, but at what point do you not want to see the whole message? When it has more than 999 lines? 10,000? 1,000,000? My point is, it typically makes sense to have a cap on how many lines you would see, and this number allows you to set that.
Since I am making an argument for what you generally want to see when looking at your tags, it probably makes sense to set something like this as an alias (from Iulian Onofrei's comment below):
git config --global alias.tags 'tag -n99'
I mean, you don't really want to have to type in git tag -n99
every time you just want to see your tags do you? Once that alias is configured, whenever you want to see your tags, you would just type git tags
into your terminal. Personally, I prefer to take things a step further than this and create even more abbreviated bash aliases for all my commonly used commands. For that purpose, you could add something like this to your .bashrc file (works on Linux and similar environments):
alias gtag='git tag -n99'
Then whenever you want to see your tags, you just type gtag
. Another advantage of going down the alias path (either git aliases or bash aliases or whatever) is you now have a spot already in place where you can add further customizations to how you personally, generally want to have your tags shown to you (like sorting them in certain ways as in my comment below, etc). Once you get over the hurtle of creating your first alias, you will now realize how easy it is to create more of them for other things you like to work in a customized way, like git log
, but let's save that one for a different question/answer.
git config --global alias.tags 'tag -n99'
alias gtag='git for-each-ref --format="%(refname:short) %(taggerdate) %(subject) %(body)" refs/tags | sort -V'
Mark Longair's answer (using git show
) is close to what is desired in the question. However, it also includes the commit pointed at by the tag, along with the full patch for that commit. Since the commit can be somewhat unrelated to the tag (it's only one commit that the tag is attempting to capture), this may be undesirable. I believe the following is a bit nicer:
for t in `git tag -l`; do git cat-file -p `git rev-parse $t`; done
It's far from pretty, but you could create a script or an alias that does something like this:
for c in $(git for-each-ref refs/tags/ --format='%(refname)'); do echo $c; git show --quiet "$c"; echo; done
git for-each-ref refs/tags/ --format='%(refname)'
with git tag -l
?
git tag
is porcelain and git for-each-ref
is plumbing, so the output of the latter should be more stable for scripting.
for c in $(git tag -l); do git tag -l -n1 $c; echo Commit message: `git log -n1 --format=%B --quiet "$c"`; echo; done
Use --format option
git tag -l --format='%(tag) %(subject)'
Last tag message only:
git cat-file -p $(git rev-parse $(git tag -l | tail -n1)) | tail -n +6
git cat-file -p <tag> | tail -n +6
git tag -l --format='%(contents)'
or
git for-each-ref refs/tags/ --format='%(contents)'
will output full annotation message for every tag (including signature if its signed).
%(contents:subject) will output only first line
%(contents:body) will output annotation without first line and signature (useful text only)
%(contents:signature) will output only PGP-signature
See more in man git-for-each-ref
“Field names” section.
git tag -l --format='%(tag): %(contents)'
git tag -l --format="%(tag)"$'\n'"%(contents)"
I prefer doing this on the command line, but if you don't mind a web interface and you use GitHub, you can visit https://github.com/user/repo/tags
and click on the "..." next to each tag to display its annotation.
How about "git tag -n" Mr. Jhu contributed for this answer.
Success story sharing
-l
option is to filter on a pattern. I don't see how that would be helpful here. Am I missing something?-l
is totally superfluous here