Skip to content

Commit 06d87a3

Browse files
authored
Merge pull request #9 from DavidVujic/about-annotated-tags-and-config-support
add info about the git tag sorting options
2 parents 98380ac + a1c1ee0 commit 06d87a3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/configuration.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,14 @@ stable = "stable-*"
3737
release = "v[0-9]*"
3838
```
3939

40-
It is also possible to define one single tag pattern in the `[tool.polylith]` section.
41-
Note: if both exists, the `[tool.polylith.tag.pattern]` will override.
40+
By default, Polylith uses the `-committerdate` when fetching tags with the underlying `git` command.
41+
The sorting might be incorrect when using _annotated tags_. To solve this, you can configure
42+
the sorting.
4243

44+
Example, setting a different sorting option than the default:
4345
``` toml
44-
[tool.polylith]
45-
git_tag_pattern = "stable-*"
46+
[tool.polylith.tag]
47+
sorting = ["-creatordate"]
4648
```
4749

4850
### Components and bases documentation

0 commit comments

Comments
 (0)