1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-13 13:48:40 +02:00
Jeffrey Cafferata 7baf594a13
docs: sort the GoReleaser configuration YAML code examples (#4652)
I have sorted the GoReleaser configuration YAML code examples as
follows:

```yaml
# This feature is only available in GoReleaser Pro.
# Since: v1.17 (pro)
# Default: .
# Templates: allowed
# Required
```
2024-02-27 09:56:24 -03:00

63 lines
1.5 KiB
Markdown

# Git
> Since v1.14
This allows you to change the behavior of some Git commands.
```yaml
# .goreleaser.yaml
git:
# What should be used to sort tags when gathering the current and previous
# tags if there are more than one tag in the same commit.
#
# Default: '-version:refname'
tag_sort: -version:creatordate
# What should be used to specify prerelease suffix while sorting tags when gathering
# the current and previous tags if there are more than one tag in the same commit.
#
# Since: v1.17
prerelease_suffix: "-"
# Tags to be ignored by GoReleaser.
# This means that GoReleaser will not pick up tags that match any of the
# provided values as either previous or current tags.
#
# Since: v1.21
# Templates: allowed
ignore_tags:
- nightly
- "{{.Env.IGNORE_TAG}}"
# Tags that begin with these prefixes will be ignored.
#
# This feature is only available in GoReleaser Pro.
# Since: v1.24 (pro)
# Templates: allowed
ignore_tag_prefixes:
- foo/
- "{{.Env.IGNORE_TAG_PREFIX}}/bar"
```
## Semver sorting
> Since v1.21 (pro)
This allows you to sort tags by semver:
```yaml
# .goreleaser.yml
git:
tag_sort: semver
```
It'll parse all tags, ignoring non-semver-compatible tags, and sort from newest
to oldest, so the latest tag is returned.
This has the effect of sorting non-pre-release tags before pre-release ones,
which is different from what other git sorting options might give you.
!!! success "GoReleaser Pro"
Semver sorting is a [GoReleaser Pro feature](/pro/).