Skip to content

Commit

Permalink
docs: improve docs
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
  • Loading branch information
caarlos0 committed Sep 4, 2023
1 parent 63e75ed commit d510abc
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 78 deletions.
6 changes: 3 additions & 3 deletions www/docs/customization/archive.md
Expand Up @@ -136,14 +136,14 @@ archives:
#
# Default: copied from the source file
info:
# Templateable (since v1.14.0)
# Templateable (since v1.14)
owner: root

# Templateable (since v1.14.0)
# Templateable (since v1.14)
group: root

# Must be in time.RFC3339Nano format.
# Templateable (since v1.14.0)
# Templateable (since v1.14)
mtime: "{{ .CommitDate }}"

# File mode.
Expand Down
24 changes: 23 additions & 1 deletion www/docs/customization/git.md
@@ -1,6 +1,6 @@
# Git

> Since v1.14.0.
> Since v1.14
This allows you to change the behavior of some Git commands.

Expand Down Expand Up @@ -29,3 +29,25 @@ git:
- nightly
- "{{.Env.FOO}}.*"
```

## 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/).
4 changes: 2 additions & 2 deletions www/docs/customization/monorepo.md
@@ -1,6 +1,7 @@
# Monorepo

!!! success "GoReleaser Pro"

The monorepo support is a [GoReleaser Pro feature](/pro/).

If you want to use GoReleaser within a monorepo and use tag prefixes to mark
Expand All @@ -12,7 +13,7 @@ You project falls into either one of these categories:

1. tags are like `subproject1/v1.2.3` and `subproject2/v1.2.3`;
1. tags are like `@user/thing@v1.2.3` (for a NPM package, for example)
and `v1.2.3` for the rest of the (Go) code.
and `v1.2.3` for the rest of the (Go) code.

## Usage

Expand Down Expand Up @@ -54,7 +55,6 @@ Then, the following is different from a "regular" run:

The rest of the release process should work as usual.


### Category 2

You'll need to create a `.goreleaser.yaml` for your Go code in the root of the
Expand Down
2 changes: 1 addition & 1 deletion www/docs/customization/nfpm.md
Expand Up @@ -260,7 +260,7 @@ nfpms:
# Keys are the possible targets during the installation process
# Values are the paths to the scripts which will be executed.
#
# Templates: allowed (since v1.20).
# Templates: allowed (since v1.20)
scripts:
preinstall: "scripts/preinstall.sh"
postinstall: "scripts/postinstall.sh"
Expand Down

0 comments on commit d510abc

Please sign in to comment.