Skip to content

Commit 04e4114

Browse files
author
TheSnoozer
committed
#262: Add the 'tags'-option to the main configuration
1 parent 7fcee77 commit 04e4114

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,15 @@ It's really simple to setup this plugin; below is a sample pom that you may base
366366

367367
<!-- Only consider tags matching the given pattern. This can be used to avoid leaking private tags from the repository. -->
368368
<match>*</match>
369-
369+
370+
<!--
371+
when you run git-describe it only looks only for *annotated tags* by default
372+
if you wish to consider *lightweight tags* in your describe as well you would need to switch this to *true*
373+
374+
The difference between *annotated tags* and *lightweight tags* is outlined in more depth in section [git describe and a small gotcha with tags](https://github.com/ktoso/maven-git-commit-id-plugin/#git-describe-and-a-small-gotcha-with-tags)
375+
-->
376+
<tags>false</tags>
377+
370378
<!--
371379
always print using the "tag-commits_from_tag-g_commit_id-maybe_dirty" format, even if "on" a tag.
372380
The distance will always be 0 if you're "on" the tag.

0 commit comments

Comments
 (0)